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 |
|---|
|
Signatura ResultGetFolderContents getFolderContents(ParamGetFolderContents paramGetFolderContents). Parámetros de invocación Nombre | Tipo | Obligatorio | DescripriciónDescripción |
|---|
ParamGetFolderContents(hereda de ParamBase) | folderId | String | Si | Id de la carpeta en Documentum cuyo contenido queremos obtener. | metadataNames | String[] | No(1) | Nombres de los metadatos que queremos recuperar de los contenidos de la carpeta. |
NOTA : Si no se especifican los metadatos que se quieren devolver se devuelven todos(1). Parámetros de respuesta Nombre | Tipo | Descripción |
|---|
| Anchor |
|---|
| ResultGetFolderContents |
|---|
| ResultGetFolderContents |
|---|
|
ResultGetFolderContents(hereda de ResultError) | folders | DocumentSearchResult[] | Listado de carpetas contenidos en la carpeta. | documents | DocumentSearchResult[] | Listado de documentos contenidos en la carpeta. |
Códigos de error Los errores de la invocación se encapsulan en ResultGetFolderContents Código | Nombre | Descripción |
|---|
101 | ERROR_CONEXION_PAPIRO | Error de conexión con documentum. | 131 | ERROR_GENERICO_PAPIRO | Se ha producido un error con PAPIRO. | 180 | ERROR_FOLDERNAME_NULO | Debe especificar el Id de la carpeta. | 801 | GENERIC_ERROR | Error genérico procesando la petición. |
Ejemplo de invocación Invocación| 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());
} |
|
...
| Expand |
|---|
|
Signatura ResultCreateDocument createDocument(ParamCreateDocument paramCreateDocument). Parámetros de invocación Nombre | Tipo | Obligatorio | DescripriciónDescripción |
|---|
ParamCreateDocument(hereda de ParamBase) | document | Document | Si | Documento que se quiere almacenar en Documentum. | aclName | String | No | Nombre de la lista de control de accesos al fichero. | folderId | String | No | Identificador de la carpeta. |
Parámetros de respuesta Nombre | Tipo | Descripción |
|---|
| Anchor |
|---|
| ResultCreateDocument |
|---|
| ResultCreateDocument |
|---|
|
ResultCreateDocument(hereda de ResultError) | id | String | Identificador en Documentum del documento creado. |
Códigos de error Los errores de la invocación se encapsulan en ResultCreateDocument Código | Nombre | Descripción |
|---|
101 | ERROR_CONEXION_PAPIRO | Error de conexión con documentum. | 128 | ERROR_CSV_YAEXISTE | Ya existe un documento con el CSV especificado. | 130 | ERROR_BASEDATOS_CSVPAPIRO | Error al conectar con la base de datos CCSV. | 131 | ERROR_GENERICO_PAPIRO | Se ha producido un error con PAPIRO. | 155 | ERROR_VERIFYDOCUMENTMETADATA | Hay errores en la validación de metadatos | 168 | ERROR_CREAR_ANULADO | No se puede crear un documento con estado Anulado | 169 | ERROR_CREAR_COPIA_SIMPLE | No se puede crear un documento con Tipo de Copia = Copia Simple y Estado distinto a Copia | 181 | ERROR_CREAR_SINFIRMA | No se puede crear un documento sin firmar en estado Original o Copia. | 197 | MENSAJE_ERROR_COPIA_SIMPLE_SIGN | Error al firmar con sello de órgano el documento cuando es tipo de copia simple | 209 | ERROR_MESSAGE_DIGEST | Error al generar el SHA-1 | 2009 | ERROR_METADATA_HASH | El valor del metadato dea_verificacion_resumen está mal calculado respecto al algoritmo indicado | 2010 | ERROR_UPDATE_METADATA_HASH | No se puede modificar el metadato dea_verificacion_resumen sin modificar también el contenido | 801 | GENERIC_ERROR | Error genérico procesando la petición. |
Ejemplo de invocación Invocación| 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());
} |
|
...
| Expand |
|---|
|
Signatura ResultUpdateDocument updateDocument(ParamUpdateDocument paramUpdateDocument). Parámetros de invocación Nombre | Tipo | Obligatorio | DescripriciónDescripción |
|---|
ParamUpdateDocument (hereda de ParamBase) | document | Document | Si | Documento con los nuevos datos que se van a actualizar en Documentum. | aclName | String | NO | Nombre de la lista de control de accesos al fichero. | updateContent | boolean | Si | Indica si actualiza el contenido del documento. | updateMetadata | boolean |
| Indica si se actualizan los metadatos del documento. | traceData | TraceData | Si | Información acerca de los cambios en el documento. |
Parámetros de respuesta Nombre | Tipo | Descripción |
|---|
| Anchor |
|---|
| ResultUpdateDocument |
|---|
| ResultUpdateDocument |
|---|
|
ResultUpdateDocument(hereda de ResultError) |
Códigos de error Los errores de la invocación se encapsulan en ResultUpdateDocument Código | Nombre | Descripción |
|---|
156 | ERROR_CSV_E_ID_NULOS | Debe especificar el id de Documentum o el CSV. | 126 | ERROR_CSV_NOVALIDO | Debe especificar el CSV. | 2010 | ERROR_UPDATE_METADATA_HASH | No se puede modificar el metadato dea_verificacion_resumen sin modificar también el contenido. | 2009 | ERROR_METADATA_HASH | El valor del metadato dea_verificacion_resumen está mal calculado respecto al algoritmo indicado. | 123 | ERROR_NOMBREDOCUMENTO_NOVALIDO | Debe especificar el nombre del documento. | 162 | ERROR_TIPO_DOCUMENTAL_NOVALIDO | Debe especificar el tipo documental del documento. | 124 | ERROR_FORMATO_NOVALIDO | Debe especificar el formato del documento. | 125 | ERROR_CODIGOAPLICACION_NOVALIDO | Debe especificar el código de la aplicación. | 155 | ERROR_VERIFYDOCUMENTMETADATA | Hay errores en la validación de metadatos. | 209 | ERROR_MESSAGE_DIGEST | Se ha producido un error al generar el hash del documento. | 191 | ERROR_INTEGRATIONAPPLICATION | Error al recuperar la información de la integración de aplicaciones. | 190 | ERROR_INTERNALACCESS_NOTALLOWED | No está permitido el acceso del nif NIF solicitante al documento indicado. | 189 | ERROR_INTERNALACCESSCONTROL_NIFINVALID | Debe especificar el nif NIF del solicitante del servicio | 192 | ERROR_CONEXION_PAU | Se ha producido un error al realizar la conexión con
PAU | 141 | ERROR_CONEXION_SIU | Se ha producido un error al realizar la conexión con SIU | 131 | ERROR_GENERICO_PAPIRO | Se ha producido un error con PAPIRO | 101 | ERROR_CONEXION_PAPIRO | Error de conexión con documentum | 130 | ERROR_BASEDATOS_CSVPAPIRO | Error al conectar con la base de datos CCSV | 127 | ERROR_CSV_NOEXISTE | No existe documento con el CSV especificado | 801 | GENERIC_ERROR | Error genérico procesando la petición. | 733 | ERROR_DOCUMENTO_SUSTITUIDO | El documento ha sido anulado y sustituido por el documento: CSVXXXXXXXXXXXXXBENT | 732 | ERROR_DOCUMENTO_ANULADO | No se puede recuperar un documento anulado |
Ejemplo de invocación Invocación| 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());
} |
|
...
| Expand |
|---|
|
Signatura ResultGetDocumentByCitizen getDocumentByCitizen(ParamGetDocumentByCitizen paramGetDocumentByCitizen). Parámetros de invocación Nombre | Tipo | Obligatorio | DescripriciónDescripción |
|---|
ParamGetDocumentByCitizen(hereda de ParamBase) | csv | String | Si | Código seguro de verificación del documento que se desea recuperar. | attachSignatures | boolean | No | Indica si se quieres adjuntar las firmas asociadas al documento. |
Parámetros de respuesta Nombre | Tipo | Descripción |
|---|
| Anchor |
|---|
| ResultGetDocumentByCitizen |
|---|
| ResultGetDocumentByCitizen |
|---|
|
ResultGetDocumentByCitizen (hereda de ResultError) | document | Document | Documento devuelto por el servicio al realizar la consulta. | signatures | ArrayList<Signature> | Firmas asociadas al documento que se devuelve. |
Códigos de error Los errores de la invocación se encapsulan en ResultGetDocumentByCitizen Código | Nombre | Descripción |
|---|
126 | ERROR_CSV_NOVALIDO | Debe especificar el CSV. | 127 | ERROR_CSV_NOEXISTE | No existe documento con el CSV especificado. | 131 | ERROR_GENERICO_PAPIRO | Se ha producido un error con PAPIRO. | 130 | ERROR_BASEDATOS_CSVPAPIRO | Error al conectar con la base de datos CCSV. | 101 | ERROR_CONEXION_PAPIRO | Error de conexión con documentum. | 801 | GENERIC_ERROR | Error genérico procesando la petición. | 733 | ERROR_DOCUMENTO_SUSTITUIDO | El documento ha sido anulado y sustituido por el documento: CSVXXXXXXXXXXXXXBENT | 732 | ERROR_DOCUMENTO_ANULADO | No se puede recuperar un documento anulado |
Ejemplo de invocación Invocación| 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());
} |
|
...
| Expand |
|---|
|
Signatura ResultGetDocument getDocument(ParamGetDocument paramGetDocument). Parámetros de invocación Nombre | Tipo | Obligatorio | DescripriciónDescripción |
|---|
ParamGetDocument(hereda de ParamBase) | id | String | Si(1) | Identificador del documento en el gestor documental Documentum | csv | String | Si(1) | Código Seguro de Verificación del documento que se quiere recuperar. | addContent | boolean | 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 |
|---|
| Anchor |
|---|
| ResultGetDocument |
|---|
| ResultGetDocument |
|---|
|
ResultGetDocument(hereda de ResultError) | document | Document | Documento devuelto por el servicio al realizar la consulta. | signatures | ArrayList<Signature> | Firmas asociadas al documento que se devuelve. |
Códigos de error Los errores de la invocación se encapsulan en 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 NIF solicitante al documento indicado. | 189 | ERROR_INTERNALACCESSCONTROL_NIFINVALID | Debe especificar el nif NIF del solicitante del servicio | 192 | ERROR_CONEXION_PAU | Se ha producido un error al realizar la conexión con PAU. | 141 | ERROR_CONEXION_SIU | Se ha producido un error al realizar la conexión con PAU | 127 | ERROR_CSV_NOEXISTE | No existe documento con el CSV especificado | 131 | ERROR_GENERICO_PAPIRO | Se ha producido un error con PAPIRO | 130 | ERROR_BASEDATOS_CSVPAPIRO | Error al conectar con la base de datos CCSV | 2019 | ERROR_FILE_TOO_LARGE | El documento es demasiado grande. Puede descargarlo llamando al servicio web de descarga de documentos de VAJE. | 101 | ERROR_CONEXION_PAPIRO | Error de conexión con documentum | 801 | GENERIC_ERROR | Error genérico procesando la petición. | 733 | ERROR_DOCUMENTO_SUSTITUIDO | El documento ha sido anulado y sustituido por el documento: CSVXXXXXXXXXXXXXBENT | 732 | ERROR_DOCUMENTO_ANULADO | No se puede recuperar un documento anulado |
Ejemplo de invocación Invocación| 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());
} |
|
...
| Expand |
|---|
|
ResultDeleteDocument deleteDocument(ParamDeleteDocument paramDeleteDocument). Parámetros de invocación Nombre | Tipo | Obligatorio | DescripriciónDescripción |
|---|
ParamDeleteDocument(hereda de ParamBase) | id | String | Si(1) | Identificador del documento en el gestor documental Documentum | csv | String | Si(1) | Código Seguro de Verificación del documento que se quiere recuperar. |
NOTA : En caso de rellanar el id no habrá que rellenar el csv y viceversa.(1) Parámetros de respuesta Nombre | Tipo | Descripción |
|---|
| Anchor |
|---|
| ResultDeleteDocument |
|---|
| ResultDeleteDocument |
|---|
|
ResultDeleteDocument (hereda de ResultError) |
Códigos de error Los errores de la invocación se encapsulan en ResultDeleteDocument Código | Nombre | Descripción |
|---|
156 | ERROR_CSV_E_ID_NULOS | Debe especificar el identificador del documento o su CSV. | 191 | ERROR_INTEGRATIONAPPLICATION | Error al recuperar la información de la integración de aplicaciones. | 190 | ERROR_INTERNALACCESS_NOTALLOWED | No está permitido el acceso del nif NIF solicitante al documento indicado. | 189 | ERROR_INTERNALACCESSCONTROL_NIFINVALID | Debe especificar el nif 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());
} |
|
...
| Expand |
|---|
|
Signatura ResultGetSubstituteDocument getSubstituteDocument(ParamGetSubstituteDocument paramGetSubstituteDocument) Parámetros de invocación Nombre | Tipo | Obligatorio | DescripriciónDescripció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 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 |
|---|
| 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 |
|---|
|
Signatura ResultDeleteDocumentLink deleteDocumentLink(ParamDeleteDocumentLink paramDeleteDocumentLink). Parámetros de invocación Nombre | Tipo | Obligatorio | DescripriciónDescripció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 conexión 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 |
|---|
|
Signatura ResultSearch search(ParamSearch paramSearchDocument). Parámetros de invocación Nombre | Tipo | Obligatorio | DescripriciónDescripción |
|---|
ParamSearch (hereda de ParamBase) | searchType | SearchType | Si | Tipo de búsqueda que se quiere realizar. | fileFilter | FileFilter[] | Si | Tipos de documentos que se desea buscar. | metadataList | String[] | No | Lista de metadatos que se desea recuperar como
resultado. Si no se especifica, se devolverá un listado de id's | int | pageNumber | No | Indica el número de página de los resultados que se
quiere obtener | int | pageSize | No | Indica el tamaño de página de los resultados que se
quieren obtener | sortMetadataName | String | No | Nombre del metadato por el que se quiere ordenar
los resultados de la búsqueda | sortType | SortType | No | Tipo de ordenación de los resultados por el metadato especificado | historical | Boolean | No | Indica si tiene que buscarse por históricos del organismo. |
Parámetros de respuesta Códigos de error Los errores de la invocación se encapsulan en ResultSearch Código | Nombre | Descripción |
|---|
156 | ERROR_CSV_E_ID_NULOS | Debe especificar el id de Documentum o el CSV. | 131 | ERROR_GENERICO_PAPIRO | Se ha producido un error con PAPIRO. | 141 | ERROR_CONEXION_SIU | Se ha producido un error al realizar la conexión con SIU | 101 | ERROR_CONEXION_PAPIRO | Error de conexion conexión 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();
} |
|
...
| Expand |
|---|
|
Signatura ResultExecuteDQL executeDQL(ParamExecuteDQL paramExecuteDQL). Parámetros de invocación Nombre | Tipo | Obligatorio | DescripriciónDescripción |
|---|
ParamExecuteDQL(hereda de ParamBase) | dql | String | Si | Sentencia DQL que se desea ejecutar. | metadata | ArrayList<String> | No | Metadatos que queremos que se devuelvan la búsqueda. |
Parámetros de respuesta Nombre | Tipo | Descripción |
|---|
| Anchor |
|---|
| ResultExecuteDQL |
|---|
| ResultExecuteDQL |
|---|
|
ResultExecuteDQL(hereda de ResultError) | resultDQL | ArrayList<HashMap<String, Object>> | Array con los datos que se han devuelto de realizar la consulta DQL. |
Códigos de error Los errores de la invocación se encapsulan en ResultExecuteDQL Código | Nombre | Descripción |
|---|
131 | ERROR_GENERICO_PAPIRO | Se ha producido un error con PAPIRO. | 101 | ERROR_CONEXION_PAPIRO | Error de conexión con documentum. | 801 | GENERIC_ERROR | Error genérico procesando la petición. |
Ejemplo de invocación Invocación| 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());
} |
|
...
| Expand |
|---|
|
Signatura ResultSearchDQL searchDQL(ParamSearchDQL paramSearchDQL). Parámetros de invocación Nombre | Tipo | Obligatorio | DescripriciónDescripción |
|---|
ParamSearchDQL (hereda de ParamBase) | codDQL | String | Si | Identificador de la DQL | attributesRecovered | String[] | Si | Metadatos que queremos que devuelva la búsqueda. | attributesSearch | SearchAttribute[] | Si | Filtros de búsqueda | sortAttributes | SortAttribute[] | Si | Filtros de ordenación | maxResults | int | Si | Numero máximo de resultados | pagination | boolean | Si | Activar/Desactivar la paginación | resultsPerPage | int | Si | Resultados por pagina | page | int | Si | Numero de pagina a recuperar |
Parámetros de respuesta Nombre | Tipo | Descripción |
|---|
| Anchor |
|---|
| ResultSearchDQL |
|---|
| ResultSearchDQL |
|---|
|
ResultSearchDQL(hereda de ResultError) | resultDQL | ArrayList<HashMap<String, Object>> | Array con los datos que se han devuelto de realizar la consulta DQL. | numRegistrosEncontrados | int | Número total de registros obtenidos de la consulta |
Códigos de error Los errores de la invocación se encapsulan en ResultSearchDQL Código | Nombre | Descripción |
|---|
131 | ERROR_GENERICO_PAPIRO | Se ha producido un error con PAPIRO. | 101 | ERROR_CONEXION_PAPIRO | Error de conexión con documentum. | 801 | GENERIC_ERROR | Error genérico procesando la petición. |
Ejemplo de invocación Invocación| 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); |
|
...
| Expand |
|---|
|
Signatura ResultCreateAndVerifySignature createAndVerifySignature(ParamCreateAndVerifySignature paramCreateAndVerifySignature). Parámetros de invocación Nombre | Tipo | Obligatorio | DescripriciónDescripción |
|---|
ParamCreateAndVerifySignature(hereda de ParamBase) | document | Document | Si(2) | Documento con la firma que se va a archivar en el repositorio documental. | signature | DataHandler | Si | Firma del documento sin codificar en base64. | id | String | Si(1) | Identificador del documento en Documentum si no hay que crearlo nuevo. | csv | String | Si(1) | CSV del documento si no hay que crearlo de nuevo. | createDocument | boolean | Si(2) | Indica si queremos crear el documento o no. | signatureType | int | Si | Tipo de firma. | initFormat | int | Si | Subformato de la firma. | finalFormat | int | No | Se indica al subformato de firma si se quiere elevar. | attachedSignature | boolean | Si | Indica si se trata de una firma adjunta. | aclName | String | No | Nombre de la lista de control de accesos al fichero. | folderId. | String | No | Identificador de la carpeta. |
NOTA : En caso de indicarse el CSV no se deberá indicar el id y viceversa. NOTA 2 : En caso de marcar createDocument como true habrá que proporcionar el documento completo en caso contrario o habrá que indicar el CSV o el id. Parámetros de respuesta Nombre | Tipo | Descripción |
|---|
| Anchor |
|---|
| ResultCreateAndVerifySignature |
|---|
| ResultCreateAndVerifySignature |
|---|
|
ResultCreateAndVerifySignature(hereda de ResultError) | signatureId | String | id de la firma guardada en documentum | documentumId | String | id del documento guardado en documentum |
Códigos de error Los errores de la invocación se encapsulan en ResultSearch Código | Nombre | Descripción |
|---|
156 | ERROR_CSV_E_ID_NULOS | Debe especificar el id de Documentum o el CSV. | 136 | ERROR_FIRMA_FORMATONULO | Debe especificar el formato de la firma para su
verificación. | 177 | ERROR_SIGNATURETYPE_INVALID | El tipo de firma indicado no se corresponde con el
tipo de la firma proporcionada. | 178 | ERROR_SUBFORMAT_INVALID_FOR_FORMAT | El formato de firma no se puede elevar al subformato indicado. | 179 | ERROR_SUBFORMAT_INVALID_FOR_INITFORMAT | El subformato al que se desea elevar no puede ser
inferior al formato actual de la firma proporcionada. | 2005 | ERROR_SUBFORMAT_INVALID | El subformato de la firma es inferior al permitido. | 203 | ERROR_DATAHANDLER_ARRAYBYTE_CSV | Error al pasar dataHandler a ArrayByte | 138 | ERROR_DOCUMENTONULO | Debe especificar el parámetro documento. | 139 | ERROR_FIRMANULA | Debe especificar el parámetro firma. | 2010 | ERROR_UPDATE_METADATA_HASH | No se puede modificar el metadato dea_verificacion_resumen sin modificar también el contenido . | 2009 | ERROR_METADATA_HASH | El valor del metadato dea_verificacion_resumen está mal calculado respecto al algoritmo indicado | 191 | ERROR_INTEGRATIONAPPLICATION | Error al recuperar la información de la integración de aplicaciones. | 190 | ERROR_INTERNALACCESS_NOTALLOWED | No está permitido el acceso del nif solicitante al
documento indicado. | 189 | ERROR_INTERNALACCESSCONTROL_NIFINVALID | Debe especificar el nif del solicitante del servicio. | 192 | ERROR_CONEXION_PAU | Se ha producido un error al realizar la conexión con
PAU | 141 | ERROR_CONEXION_SIU | Se ha producido un error al realizar la conexión con
SIU. | 1131 | ERROR_ASF_VALIDATE_SIGNATURE | Error al validar la firma. | 131 | ERROR_GENERICO_PAPIRO | Se ha producido un error con PAPIRO. | 101 | ERROR_CONEXION_PAPIRO | Error de conexión con documentum. | 801 | GENERIC_ERROR | Error genérico procesando la petición. | 733 | ERROR_DOCUMENTO_SUSTITUIDO | El documento ha sido anulado y sustituido por el documento: CSVXXXXXXXXXXXXXBENT | 732 | ERROR_DOCUMENTO_ANULADO | No se puede recuperar un documento anulado |
Ejemplo de invocación Invocación| 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());
} |
|
...
| Expand |
|---|
|
Signatura ResultCreateWithoutVerifySignature createWithoutVerifySignature(ParamCreateWithoutVerifySignature paramCreateWithoutVerifySignature). Parámetros de invocación Nombre | Tipo | Obligatorio | DescripriciónDescripción |
|---|
ParamCreateWithoutVerifySignature (hereda de ParamBase) | document | Document | Si(2) | Documento que se desea almacenar junto con la firma proporcionada. | id | String | Si(1) | Identificador del documento al que se desea asociar la
firma, en el caso de que no haya que crearlo. | csv | String | Si(1) | CSV del documento al que se desea asociar la firma,
en el caso de que no haya que crearlo. | createDocument | boolean | Si(2) | Indica si hay que almacenar primero el documento pasado por parámetro o la firma se debe vincular al documento cuyo id se proporciona. | attachedSignature | boolean | Si | Indica si se trata de una firma adjunta | aclName | String | No | Nombre de la lista de control de acceso o ACL con la que se quiere almacenar el documento. En caso de no informarse se utilizará el ACL por defecto proporcionado por CCSV. | folderId | String | No | Identificador de la carpeta donde se quiere almacenar el documento. En caso de no rellenarse se almacenará en la carpeta proporcionada por CCSV. |
NOTA : En caso de indicarse el CSV no se deberá indicar el id y viceversa.(1) NOTA 2 : En caso de marcar createDocument como true habrá que proporcionar el documento completo en caso contrario o habrá que indicar el CSV o el id.(2) Parámetros de respuesta Nombre | Tipo | Descripción |
|---|
| Anchor |
|---|
| ResultCreateWithoutVerifySignature |
|---|
| ResultCreateWithoutVerifySignature |
|---|
|
ResultCreateWithoutVerifySignature(hereda de ResultError) | documentId | String | Identificador en Documentum del documento almacenado. | signatureId | String | Identificador en Documentum de la firma asociada al documento- |
Códigos de error Los errores de la invocación se encapsulan en ResultCreateWithoutVerifySignature Código | Nombre | Descripción |
|---|
156 | ERROR_CSV_E_ID_NULOS | Debe especificar el identificador del documento o su CSV. | 203 | ERROR_DATAHANDLER_ARRAYBYTE_CSV | Error al pasar dataHandler a ArrayByte. | 138 | ERROR_DOCUMENTONULO | Debe especificar el parámetro documento. | 2010 | ERROR_UPDATE_METADATA_HASH | No se puede modificar el metadato dea_verificacion_resumen sin modificar también el contenido. | 2009 | ERROR_METADATA_HASH | El valor del metadato dea_verificacion_resumen está mal calculado respecto al algoritmo indicado. | 191 | ERROR_INTEGRATIONAPPLICATION | Error al recuperar la información de la integración de aplicaciones. | 190 | ERROR_INTERNALACCESS_NOTALLOWED | No está permitido el acceso del nif solicitante al documento indicado. | 189 | ERROR_INTERNALACCESSCONTROL_NIFINVALID | Debe especificar el nif del solicitante del servicio. | 192 | ERROR_CONEXION_PAU | Se ha producido un error al realizar la conexión con PAU. | 141 | ERROR_CONEXION_SIU | Se ha producido un error al realizar la conexión con SIU. | 131 | ERROR_GENERICO_PAPIRO | Se ha producido un error con PAPIRO. | 101 | ERROR_CONEXION_PAPIRO | Error de conexión con documentum. | 801 | GENERIC_ERROR | Error genérico procesando la petición. | 733 | ERROR_DOCUMENTO_SUSTITUIDO | El documento ha sido anulado y sustituido por el documento: CSVXXXXXXXXXXXXXBENT | 732 | ERROR_DOCUMENTO_ANULADO | No se puede recuperar un documento anulado |
Ejemplo de invocación Invocación| 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());
} |
|
...
| Expand |
|---|
|
Signatura ResultDeleteSignature deleteSignature(ParamDeleteSignature paramDeleteSignature). Parámetros de invocación Nombre | Tipo | Obligatorio | DescripriciónDescripción |
|---|
ParamDeleteSignature(hereda de ParamBase) | signatureId | String | Si | Identificador de la firma en Documentum. |
Parámetros de respuesta Nombre | Tipo | Descripción |
|---|
| Anchor |
|---|
| ResultDeleteSignature |
|---|
| ResultDeleteSignature |
|---|
|
ResultDeleteSignature(hereda de ResultError) |
Códigos de error Los errores de la invocación se encapsulan en ResultDeleteSignature Código | Nombre | Descripción |
|---|
131 | ERROR_GENERICO_PAPIRO | Se ha producido un error con PAPIRO. | 101 | ERROR_CONEXION_PAPIRO | Error de conexión con documentum. | 801 | GENERIC_ERROR | Error genérico procesando la petición. |
Ejemplo de invocación Invocación| 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());
} |
|
...
| Expand |
|---|
|
Signatura ResultUpdateAndVerifySignature updateAndVerifySignature(ParamUpdateAndVerifySignature paramUpdateAndVerifySignature). Parámetros de invocación Nombre | Tipo | Obligatorio | DescripriciónDescripción |
|---|
ParamUpdateAndVerifySignature(hereda de ParamBase) | aclName | String | No | Nombre de la lista de control de accesos al fichero. | folderId | String | No | Identificador de la carpeta. | csv | String | Si(1) | CSV del documento en Documentum. | id | String | Si(1) | Identificador del documento en Documentum. | signatureId | String | Si | Identificador de la firma. | attachedSignature | boolean | Si | Indica si se trata de una firma adjunta. | signatureType | int | Si | Indica el tipo de firma. | initFormat | int | Si | Subformato de la firma. | finalFormat | int | No | Se indica al subformato de firma si se quiere elevar. | signature | DataHandler | Si | Firma en binario y sin codificar en base64 que se desea verificar y almacenar en el sistema de gestión documental asociada al documento indicado sustituyendo a la firma indicada. |
NOTA : En caso de indicarse el CSV no se deberá indicar el id y viceversa. Parámetros de respuesta Nombre | Tipo | Descripción |
|---|
| Anchor |
|---|
| ResultUpdateAndVerifySignature |
|---|
| ResultUpdateAndVerifySignature |
|---|
|
ResultUpdateAndVerifySignature(hereda de ResultError) | signatureId | String | Identificador en Documentum de la firma reemplazada. |
Códigos de error Los errores de la invocación se encapsulan en ResultUpdateAndVerifySignature. Código | Nombre | Descripción |
|---|
175 | ERROR_IDFIRMANULA | Debe especificar el parámetro ID de la firma. | 156 | ERROR_CSV_E_ID_NULOS | Debe especificar el identificador del documento o su CSV. | 177 | ERROR_SIGNATURETYPE_INVALID | El tipo de firma indicado no se corresponde con el tipo de la firma proporcionada. | 178 | ERROR_SUBFORMAT_INVALID_FOR_FORMAT | El formato de firma no se puede elevar al subformato indicado. | 179 | ERROR_SUBFORMAT_INVALID_FOR_INITFORMAT | El subformato al que se desea elevar no puede ser inferior al formato actual de la firma proporcionada. | 2005 | ERROR_SUBFORMAT_INVALID | El subformato de la firma es inferior al permitido. | 203 | ERROR_DATAHANDLER_ARRAYBYTE_CSV | Error al pasar dataHandler a ArrayByte. | 176 | ERROR_SIGNATUREID_NOTFOUND | No existe la firma indicada para el documento cuyo identificador o csv se ha proporcionado. | 139 | ERROR_FIRMANULA | Debe especificar el parámetro firma | 191 | ERROR_INTEGRATIONAPPLICATION | Error al recuperar la información de la integración de aplicaciones. | 190 | ERROR_INTERNALACCESS_NOTALLOWED | No está permitido el acceso del nif solicitante al documento indicado. | 189 | ERROR_INTERNALACCESSCONTROL_NIFINVALID | Debe especificar el nif del solicitante del servicio | 192 | ERROR_CONEXION_PAU | Se ha producido un error al realizar la conexión con PAU | 141 | ERROR_CONEXION_SIU | Se ha producido un error al realizar la conexión con SIU | 1131 | ERROR_ASF_VALIDATE_SIGNATURE | Error al validar firma | 131 | ERROR_GENERICO_PAPIRO | Se ha producido un error con PAPIRO. | 101 | ERROR_CONEXION_PAPIRO | Error de conexión con documentum. | 801 | GENERIC_ERROR | Error genérico procesando la petición. | 733 | ERROR_DOCUMENTO_SUSTITUIDO | El documento ha sido anulado y sustituido por el documento: CSVXXXXXXXXXXXXXBENT | 732 | ERROR_DOCUMENTO_ANULADO | No se puede recuperar un documento anulado |
Ejemplo de invocación Invocación| 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());
} |
|
...
| Expand |
|---|
|
Signatura ResultUpdateWithoutVerifySignature updateWithoutVerifySignature(ParamUpdateWithoutVerifySignature paramUpdateWithoutVerifySignature). Parámetros de invocación Nombre | Tipo | Obligatorio | DescripriciónDescripción |
|---|
ParamUpdateWithoutVerifySignature (hereda de ParamBase) | id | String | Si(1) | Identificador del documento al que se desea asociar la firma, en el caso de que no haya que crearlo. | csv | String | Si(1) | CSV del documento al que se desea asociar la firma, en el caso de que no haya que crearlo. | signature | DataHandler | Si | Firma en binario y sin codificar en base64 que se desea verificar y almacenar en el sistema de gestión documental asociada al documento indicado sustituyendo a la firma indicada. | attachedSignature | boolean | Si | Indica si se trata de una firma adjunta. | aclName | String | No | Nombre de la lista de control de acceso o ACL con la que se quiere almacenar el documento. En caso de no informarse se utilizará el ACL por defecto proporcionado por CCSV. | folderId | String | No | Identificador de la carpeta. |
NOTA : En caso de indicarse el CSV no se deberá indicar el id y viceversa. Parámetros de respuesta Nombre | Tipo | Descripción |
|---|
| Anchor |
|---|
| ResultUpdateWithoutVerifySignature |
|---|
| ResultUpdateWithoutVerifySignature |
|---|
|
ResultUpdateWithoutVerifySignature (hereda de ResultError) | signatureId | String | Identificador en Documentum de la firma reemplazada. |
Códigos de error Los errores de la invocación se encapsulan en ResultUpdateWithoutVerifySignature. Código | Nombre | Descripción |
|---|
156 | ERROR_CSV_E_ID_NULOS | Debe especificar el identificador del documento o su CSV. | 203 | ERROR_DATAHANDLER_ARRAYBYTE_CSV | Error al pasar dataHandler a ArrayByte | 191 | ERROR_INTEGRATIONAPPLICATION | Error al recuperar la información de la integración de aplicaciones. | 190 | ERROR_INTERNALACCESS_NOTALLOWED | No está permitido el acceso del nif solicitante al documento indicado. | 189 | ERROR_INTERNALACCESSCONTROL_NIFINVALID | Debe especificar el nif del solicitante del servicio | 192 | ERROR_CONEXION_PAU | Se ha producido un error al realizar la conexión con PAU | 141 | ERROR_CONEXION_SIU | Se ha producido un error al realizar la conexión con SIU | 1131 | ERROR_ASF_VALIDATE_SIGNATURE | Error al validar firma | 131 | ERROR_GENERICO_PAPIRO | Se ha producido un error con PAPIRO. | 101 | ERROR_CONEXION_PAPIRO | Error de conexión con documentum. | 801 | GENERIC_ERROR | Error genérico procesando la petición. | 733 | ERROR_DOCUMENTO_SUSTITUIDO | El documento ha sido anulado y sustituido por el documento: CSVXXXXXXXXXXXXXBENT | 732 | ERROR_DOCUMENTO_ANULADO | No se puede recuperar un documento anulado |
Ejemplo de invocación Invocación| 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());
} |
|
...
| Expand |
|---|
|
Signatura ResultUpdateAndSignDocument updateAndSignDocument(ParamUpdateAndSignDocument paramUpdateAndSignDocument). Parámetros de invocación Nombre | Tipo | Obligatorio | DescripriciónDescripción |
|---|
ParamUpdateAndSignDocument (hereda de ParamBase) | document | Document | Si | Documento que se desea almacenar junto con la firma proporcionada. | signature | DataHandler | Si | Firma en binario y sin codificar en base64 que se desea verificar y almacenar en el sistema de gestión documental asociada al documento indicado.. | signatureType | int | Si | Tipo de firma. | initFormat | int | Si | Subformato de la firma. | finalFormat | int | No | Se indica al subformato de firma si se quiere elevar. | attachedSignature | boolean | Si | Indica si la firma es adjunta. | updateMetadata | boolean | No | Indica si se tienen que actualizar los metadatos del documento. En este caso, el objeto document debe venir relleno con los mismos. | aclName | String | No | Nombre de la lista de control de acceso o ACL con la que se quiere almacenar el documento. En caso de no informarse se utilizará el ACL por defecto proporcionado por CCSV. | folderId | String | No | Identificador de la carpeta donde se quiere almacenar el documento. En caso de no rellenarse se almacenará en la carpeta proporcionada por CCSV. | traceData | TraceData | Si | Metadatos de la traza |
Parámetros de respuesta Nombre | Tipo | Descripción |
|---|
| Anchor |
|---|
| ResultUpdateAndSignDocument |
|---|
| ResultUpdateAndSignDocument |
|---|
|
ResultUpdateAndSignDocument (hereda de ResultError) | signatureId | String | id de la firma guardada en documentum. | documentumId | String | id del documento guardado en documentum. |
Códigos de error Los errores de la invocación se encapsulan en ResultUpdateAndSignDocument. Código | Nombre | Descripción |
|---|
156 | ERROR_CSV_E_ID_NULOS | Debe especificar el id de Documentum o el CSV. | 126 | ERROR_CSV_NOVALIDO | Debe especificar el CSV. | 2010 | ERROR_UPDATE_METADATA_HASH | No se puede modificar el metadato dea_verificacion_resumen sin modificar también el contenido. | 123 | ERROR_NOMBREDOCUMENTO_NOVALIDO | Debe especificar el nombre del documento. | 162 | ERROR_TIPO_DOCUMENTAL_NOVALIDO | Debe especificar el tipo documental del documento. | 124 | ERROR_FORMATO_NOVALIDO | Debe especificar el formato del documento. | 125 | ERROR_CODIGOAPLICACION_NOVALIDO | Debe especificar el código de la aplicación. | 155 | ERROR_VERIFYDOCUMENTMETADATA | Hay errores en la validación de metadatos. | 209 | ERROR_MESSAGE_DIGEST | Se ha producido un error al generar el hash del documento. | 130 | ERROR_BASEDATOS_CSVPAPIRO | Error al conectar con la base de datos CCSV | 127 | ERROR_CSV_NOEXISTE | No existe documento con el CSV especificado | 136 | ERROR_FIRMA_FORMATONULO | Debe especificar el formato de la firma para su
verificación. | 177 | ERROR_SIGNATURETYPE_INVALID | El tipo de firma indicado no se corresponde con el
tipo de la firma proporcionada. | 178 | ERROR_SUBFORMAT_INVALID_FOR_FORMAT | El formato de firma no se puede elevar al subformato indicado. | 179 | ERROR_SUBFORMAT_INVALID_FOR_INITFORMAT | El subformato al que se desea elevar no puede ser
inferior al formato actual de la firma proporcionada. | 2005 | ERROR_SUBFORMAT_INVALID | El subformato de la firma es inferior al permitido. | 203 | ERROR_DATAHANDLER_ARRAYBYTE_CSV | Error al pasar dataHandler a ArrayByte | 138 | ERROR_DOCUMENTONULO | Debe especificar el parámetro documento. | 139 | ERROR_FIRMANULA | Debe especificar el parámetro firma. | 2009 | ERROR_METADATA_HASH | El valor del metadato dea_verificacion_resumen está mal calculado respecto al algoritmo indicado | 191 | ERROR_INTEGRATIONAPPLICATION | Error al recuperar la información de la integración de aplicaciones. | 190 | ERROR_INTERNALACCESS_NOTALLOWED | No está permitido el acceso del nif NIF solicitante al
documento indicado. | 189 | ERROR_INTERNALACCESSCONTROL_NIFINVALID | Debe especificar el nif NIF del solicitante del servicio. | 192 | ERROR_CONEXION_PAU | Se ha producido un error al realizar la conexión con
PAU | 141 | ERROR_CONEXION_SIU | Se ha producido un error al realizar la conexión con
SIU. | 1131 | ERROR_ASF_VALIDATE_SIGNATURE | Error al validar la firma. | 131 | ERROR_GENERICO_PAPIRO | Se ha producido un error con PAPIRO. | 101 | ERROR_CONEXION_PAPIRO | Error de conexión con documentum. | 801 | GENERIC_ERROR | Error genérico procesando la petición. | 733 | ERROR_DOCUMENTO_SUSTITUIDO | El documento ha sido anulado y sustituido por el documento: CSVXXXXXXXXXXXXXBENT | 732 | ERROR_DOCUMENTO_ANULADO | No se puede recuperar un documento anulado |
Ejemplo de invocación Invocación| 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());
} |
|
...
| Expand |
|---|
|
Signatura ResultGetDocumentSignatures getDocumentSignatures(ParamGetDocumentSignatures paramGetDocumentSignatures). Parámetros de invocación Nombre | Tipo | Obligatorio | DescripriciónDescripción |
|---|
ParamGetDocumentSignatures(hereda de ParamBase) | id | String | Si(1) | Codigo Código identificador de la firma en el repositorio documental. | csv | String | Si(1) | Código ccsv de la firma en el repositorio documental. |
NOTA : En caso de indicarse el CSV no se deberá indicar el id y viceversa.(1) Parámetros de respuesta Nombre | Tipo | Descripción |
|---|
| 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 NIF solicitante al documento indicado. | 189 | ERROR_INTERNALACCESSCONTROL_NIFINVALID | Debe especificar el nif 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étodo
| Anchor |
|---|
| initializeDocumentMetadata |
|---|
| initializeDocumentMetadata |
|---|
|
'initializeDocumentMetadata'
...
| Expand |
|---|
|
Signatura ResultInitializeStructuredMetadata initializeStructuredMetadata(ParamInitializeStructuredMetadata paramInitializeStructuredMetadata). Parámetros de invocación Nombre | Tipo | Obligatorio | DescripriciónDescripción |
|---|
ParamInitializeStructuredMetadata (hereda de ParamBase) | metadataName | String | si | Nombre del metadato estructurado que se quiere inicializar. |
Parámetros de respuesta Nombre | Tipo | Descripción |
|---|
| Anchor |
|---|
| ResultInitializeStructuredMetadata |
|---|
| ResultInitializeStructuredMetadata |
|---|
|
ResultInitializeStructuredMetadata(hereda de ResultError) | document | Document | Documento con la estructura de metadatos del metadato estructurado correspondiente. |
Códigos de error Los errores de la invocación se encapsulan en ResultInitializeStructuredMetadata Código | Nombre | Descripción |
|---|
147 | ERROR_NOT_STRUCTUREDMETADATAID | El id facilitado no pertenece a un metadato estructurado. | 143 | ERROR_METADATA_MODEL | Error al recuperar la información del modelo de metadatos. | 801 | GENERIC_ERROR | Error genérico procesando la petición. |
Ejemplo de invocación Invocación| 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());
} |
|
...
| Expand |
|---|
|
Signatura ResultVerifyMetadataValue verifyMetadataValue(ParamVerifyMetadataValue paramVerifyMetadataValue);. Parámetros de invocación Nombre | Tipo | Obligatorio | DescripriciónDescripción |
|---|
ParamVerifyMetadataValue(hereda de ParamBase) | metadataName | String | Si | Nombre del metadato simple que se va a verificar. | value | String | Si | Valor que se quiere validar para ese metadato. |
Parámetros de respuesta Nombre | Tipo | Descripción |
|---|
| Anchor |
|---|
| ResultVerifyMetadataValue |
|---|
| ResultVerifyMetadataValue |
|---|
|
ResultVerifyMetadataValue (hereda de ResultError) | metadataValueVerification | MetadataValueVerification | Indica el nombre del metadato y el error por el cual no es válido el valor verificado. |
Códigos de error Los errores de la invocación se encapsulan en ResultVerifyMetadataValue Código | Nombre | Descripción |
|---|
143 | ERROR_METADATA_MODEL | Error al recuperar la información del modelo de metadatos. | 801 | GENERIC_ERROR | Error genérico procesando la petición. |
Ejemplo de invocación | 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();
}
} |
|
...
| Expand |
|---|
|
Signatura ResultVerifyDocumentMetadata verifyDocumentMetadata(ParamVerifyDocumentMetadata paramVerifyDocumentMetadata);. Parámetros de invocación Nombre | Tipo | Obligatorio | DescripriciónDescripción |
|---|
ParamVerifyDocumentMetadata(hereda de ParamBase) | document | Document | Si(1) | Documento cuyos metadatos se quiere verificar. | documentType | String | Si | Tipo de documento del documento cuyos metadatos se quiere verificar. |
NOTA:El parámetro "content" debera ir obligatoriamente nulo.(1) Parámetros de respuesta Nombre | Tipo | Descripción |
|---|
| Anchor |
|---|
| ResultVerifyDocumentMetadata |
|---|
| ResultVerifyDocumentMetadata |
|---|
|
ResultVerifyDocumentMetadata(hereda de ResultError) | metadataValueVerificationList | List<MetadataValueVerification > | En caso de producirse errores en la
validación de los metadatos del
documento, almacena la lista de
errores de validación. |
Códigos de error Los errores de la invocación se encapsulan en ResultVerifyDocumentMetadata Código | Nombre | Descripción |
|---|
143 | ERROR_METADATA_MODEL | Error al recuperar la información del modelo de metadatos. | 144 | ERROR_INITIALIZE_DOCUMENTTYPE_NOEXISTE | No existe el tipo de documento indicado | 145 | ERROR_INITIALIZE_DOCUMENTUMTYPE_NOEXISTE | No existe el tipo documental indicado | 146 | ERROR_INITIALIZE_DOCUMENTTYPE_DOCUMENTUMTYPE_NULO | Debe indicar el tipo de documento (documentType) o el tipo documental (document.type) | 801 | GENERIC_ERROR | Error genérico procesando la petición. |
Ejemplo de invocación Invocación| 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());
} |
|
...
| Expand |
|---|
|
Signatura ResultGetMetadataValueList getMetadataValueList(ParamGetMetadataValueList paramGetMetadataValueList). Parámetros de invocación Nombre | Tipo | Obligatorio | DescripriciónDescripción |
|---|
ParamGetMetadataValueList(hereda de ParamBase) | metadataName | String | Si(1) | Nombre del metadato tal y como se está dado de alta
en Documentum. | metadataNameNTI | String | Si(1) | Nombre del metadato según la norma técnica de
interoperabilidad(NTI)). | defaultOnly | boolean | Si | Indica si sólo se desea obtener el valor por defecto o
todos los valores. |
NOTA: En caso de rellenar el metadataName no se indicará el metadataNameNTI y viceversa.(1) Parámetros de respuesta Nombre | Tipo | Descripción |
|---|
| Anchor |
|---|
| ResultGetMetadataValueList |
|---|
| ResultGetMetadataValueList |
|---|
|
ResultGetMetadataValueList(hereda de ResultError) | metadataValueList | List<MetadataValue> | Lista de valores posibles del metadato indicado. |
Códigos de error Los errores de la invocación se encapsulan en ResultGetMetadataValueList Código | Nombre | Descripción |
|---|
154 | ERROR_METADATANAME_METADATANAMEID_NULO | Debe indicar el nombre del metadato en Documentum o el nombre del metadato según la NTI. | 707 | ERROR_METADATAID_NOEXISTE | No existe un metadato con el identificador especificado | 143 | ERROR_METADATA_MODEL | Error al recuperar la información del modelo de metadatos | 801 | GENERIC_ERROR | Error genérico procesando la petición. |
Ejemplo de invocación Invocación| 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());
} |
|
...
| Expand |
|---|
|
Signatura ResultGetMetadataList getMetadataList(ParamGetMetadataList paramGetMetadataList). Parámetros de invocación Nombre | Tipo | Obligatorio | DescripriciónDescripción |
|---|
ParamGetMetadataList(hereda de ParamBase) | documentumTypeName | String | Si(1) | Nombre del tipo del documento tal y como se está dado de alta en Documentum. | documentumTypeNameNTI | String | Si(1) | Nombre del tipo del documento según la norma técnica de interoperabilidad(NTI)). |
NOTA: En caso de rellenar el documentumTypeName no se indicará el documentumTypeNameNTI y viceversa.(1) Parámetros de respuesta Nombre | Tipo | Descripción |
|---|
| Anchor |
|---|
| ResultGetMetadataList |
|---|
| ResultGetMetadataList |
|---|
|
ResultGetMetadataList(hereda de ResultError) | metadataList | List<Metadata> | Lista de valores posibles del metadato indicado. |
Códigos de error Los errores de la invocación se encapsulan en ResultGetMetadataList Código | Nombre | Descripción |
|---|
159 | ERROR_DOCUMENTUMTYPENAME_NULO | Faltan los parámetros para identificar al tipo
documental. | 160 | ERROR_DOCUMENTUMTYPE_NOEXISTE | No existe el tipo de documento indicado. | 722 | ERROR_GET_METADATALIST | No existe ningún metadato para ese tipo documental. | 143 | ERROR_METADATA_MODEL | Error al recuperar la información del modelo de
metadatos. | 801 | GENERIC_ERROR | Error genérico procesando la petición. |
Ejemplo de invocación Invocación| 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());
} |
|
...
| Expand |
|---|
|
Signatura ResultGetMetadata getMetadata(ParamGetMetadata paramGetMetadata). Parámetros de invocación Nombre | Tipo | Obligatorio | DescripriciónDescripción |
|---|
ParamGetMetadataList(hereda de ParamBase) | id | String | Si(1) | Identificador del documento en Documentum. | csv | String | Si(1) | csv del documento en Documentum. | metadataNames | String | Si | Nombres de los metadatos cuyos valores se quieren recuperar. |
NOTA: En caso de indicar el id no se indicara el csv o viceversa.(1) Parámetros de respuesta Nombre | Tipo | Descripción |
|---|
| Anchor |
|---|
| ResultGetMetadata |
|---|
| ResultGetMetadata |
|---|
|
ResultGetMetadata(hereda de ResultError) | metadata | HashMap<String,Object> | Estructura que almacena por cada clave o nombre del metadato, los valores de los mismos. |
Códigos de error Los errores de la invocación se encapsulan en ResultGetMetadata Código | Nombre | Descripción |
|---|
156 | ERROR_CSV_E_ID_NULOS | Debe especificar el identificador del documento o su CSV | 127 | ERROR_CSV_NOEXISTE | No existe documento con el CSV especificado | 131 | ERROR_GENERICO_PAPIRO | Se ha producido un error con PAPIRO | 130 | ERROR_BASEDATOS_CSVPAPIRO | Error al conectar con la base de datos CCSV. | 801 | GENERIC_ERROR | Error genérico procesando la petición. |
Ejemplo de invocación Invocación| 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());
} |
|
...
| Expand |
|---|
|
Signatura ResultChangeState changeState(ParamChangeState paramchangeState). Parámetros de invocación Nombre | Tipo | Obligatorio | DescripriciónDescripción |
|---|
ParamChangeState(hereda de ParamBase) | id | String | Si(1) | Identificador del documento en Documentum. | csv | String | Si(1) | csv del documento en Documentum. | state | String | Si | Nuevo valor para el estado del documento. | typeCopy | String | No | Nuevo tipo de copia del documento en Documentum. | traceData | TraceData | Si(2) | Datos de traza del cambio |
NOTA: En caso de indicar el id no se indicara el csv o viceversa.(1) NOTA 2 : En caso de cambiarse el documento a estado anulado habrá que rellenar el parámetro traceData.(2) Parámetros de respuesta Nombre | Tipo | Descripción |
|---|
| Anchor |
|---|
| ResultChangeState |
|---|
| ResultChangeState |
|---|
|
ResultChangeState(hereda de ResultError) |
Códigos de error Los errores de la invocación se encapsulan en ResultChangeState Código | Nombre | Descripción |
|---|
169 | ERROR_CHANGESTATE | No se puede modificar el estado | 197 | ERROR_COPIA_SIMPLE_SIGN | Error al firmar con sello de órgano el documento cuando es tipo de copia simple. | 191 | ERROR_INTEGRATIONAPPLICATION | Error al recuperar la información de la integración de aplicaciones. | 190 | ERROR_INTERNALACCESS_NOTALLOWED | No está permitido el acceso del nif solicitante al documento indicado | 189 | ERROR_INTERNALACCESSCONTROL_NIFINVALID | Debe especificar el nif del solicitante del servicio | 192 | ERROR_CONEXION_PAU | Se ha producido un error al realizar la conexión con
PAU | 141 | ERROR_CONEXION_SIU | Se ha producido un error al realizar la conexión con SIU | 158 | ERROR_VERIFY_NOT_VALUELIST | El valor indicado no está entre los valores válidos para ese metadato. | 127 | ERROR_CSV_NOEXISTE | No existe documento con el CSV especificado | 131 | ERROR_GENERICO_PAPIRO | Se ha producido un error con PAPIRO | 130 | ERROR_BASEDATOS_CSVPAPIRO | Error al conectar con la base de datos CCSV | 801 | GENERIC_ERROR | Error genérico procesando la petición. | 733 | ERROR_DOCUMENTO_SUSTITUIDO | El documento ha sido anulado y sustituido por el documento: CSVXXXXXXXXXXXXXBENT | 732 | ERROR_DOCUMENTO_ANULADO | No se puede recuperar un documento anulado |
Ejemplo de invocación Invocación| 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());
} |
|
...
| Expand |
|---|
|
Signatura ResultChangeExternalLock changeExternalLock(ParamChangeExternalLock paramChangeExternalLock). Parámetros de invocación Nombre | Tipo | Obligatorio | DescripriciónDescripción |
|---|
ParamChangeExternalLock(hereda de ParamBase) | id | String | Si(1) | Identificador del documento en Documentum. | csv | String | Si(1) | csv del documento en Documentum. | documentLock | String | Si | Nuevo valor para el metadato bloqueo del documento. |
NOTA: En caso de indicar el id no se indicara el csv o viceversa.(1) Parámetros de respuesta Nombre | Tipo | Descripción |
|---|
| Anchor |
|---|
| ResultChangeExternalLock |
|---|
| ResultChangeExternalLock |
|---|
|
ResultChangeExternalLock(hereda de ResultError) |
Códigos de error Los errores de la invocación se encapsulan en ResultChangeExternalLock Código | Nombre | Descripción |
|---|
156 | ERROR_CSV_E_ID_NULOS | Debe especificar el identificador del documento o su CSV | 191 | ERROR_INTEGRATIONAPPLICATION | Error al recuperar la información de la integración de aplicaciones. | 190 | ERROR_INTERNALACCESS_NOTALLOWED | No está permitido el acceso del nif solicitante al documento indicado | 189 | ERROR_INTERNALACCESSCONTROL_NIFINVALID | Debe especificar el nif del solicitante del servicio | 192 | ERROR_CONEXION_PAU | Se ha producido un error al realizar la conexión con
PAU | 141 | ERROR_CONEXION_SIU | Se ha producido un error al realizar la conexión con SIU | 158 | ERROR_VERIFY_NOT_VALUELIST | El valor indicado no está entre los valores válidos para ese metadato. | 127 | ERROR_CSV_NOEXISTE | No existe documento con el CSV especificado | 131 | ERROR_GENERICO_PAPIRO | Se ha producido un error con PAPIRO | 130 | ERROR_BASEDATOS_CSVPAPIRO | Error al conectar con la base de datos CCSV | 801 | GENERIC_ERROR | Error genérico procesando la petición. | 733 | ERROR_DOCUMENTO_SUSTITUIDO | El documento ha sido anulado y sustituido por el documento: CSVXXXXXXXXXXXXXBENT | 732 | ERROR_DOCUMENTO_ANULADO | No se puede recuperar un documento anulado |
Ejemplo de invocación Invocación| 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());
} |
|
...
| Expand |
|---|
|
Signatura ResultChangeDocumentVisibility changeDocumentVisibility(ParamChangeDocumentVisibility paramChangeDocumentVisibility). Parámetros de invocación Nombre | Tipo | Obligatorio | DescripriciónDescripción |
|---|
ParamChangeDocumentVisibility(hereda de ParamBase) | id | String | Si(1) | Identificador del documento en Documentum. | csv | String | Si(1) | csv del documento en Documentum. | documentVisibility | String | Si | Nuevo valor para la visibilidad del documento. |
NOTA: En caso de indicar el id no se indicara el csv o viceversa.(1) Parámetros de respuesta Nombre | Tipo | Descripción |
|---|
| Anchor |
|---|
| ResultChangeDocumentVisibility |
|---|
| ResultChangeDocumentVisibility |
|---|
|
ResultChangeDocumentVisibility(hereda de ResultError) |
Códigos de error Los errores de la invocación se encapsulan en ResultChangeDocumentVisibility Código | Nombre | Descripción |
|---|
156 | ERROR_CSV_E_ID_NULOS | Debe especificar el identificador del documento o su CSV | 191 | ERROR_INTEGRATIONAPPLICATION | Error al recuperar la información de la integración de aplicaciones. | 190 | ERROR_INTERNALACCESS_NOTALLOWED | No está permitido el acceso del nif solicitante al documento indicado | 189 | ERROR_INTERNALACCESSCONTROL_NIFINVALID | Debe especificar el nif del solicitante del servicio | 192 | ERROR_CONEXION_PAU | Se ha producido un error al realizar la conexión con
PAU | 141 | ERROR_CONEXION_SIU | Se ha producido un error al realizar la conexión con SIU | 158 | ERROR_VERIFY_NOT_VALUELIST | El valor indicado no está entre los valores válidos para ese metadato. | 127 | ERROR_CSV_NOEXISTE | No existe documento con el CSV especificado | 131 | ERROR_GENERICO_PAPIRO | Se ha producido un error con PAPIRO | 130 | ERROR_BASEDATOS_CSVPAPIRO | Error al conectar con la base de datos CCSV | 801 | GENERIC_ERROR | Error genérico procesando la petición. | 733 | ERROR_DOCUMENTO_SUSTITUIDO | El documento ha sido anulado y sustituido por el documento: CSVXXXXXXXXXXXXXBENT | 732 | ERROR_DOCUMENTO_ANULADO | No se puede recuperar un documento anulado |
Ejemplo de invocación Invocación| 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());
} |
|
...
| Expand |
|---|
|
Signatura ResultGetDocumentTypeList getDocumentTypeList(ParamGetDocumentTypeList paramDocumentTypeList). Parámetros de invocación Nombre | Tipo | Obligatorio | DescripriciónDescripción |
|---|
ParamGetDocumentTypeList(hereda de ParamBase) | highlight | boolean | Si | Indica si se desea obtener sólo los tipos de documentos
más utilizados o todos |
Parámetros de respuesta Nombre | Tipo | Descripción |
|---|
| Anchor |
|---|
| ResultGetDocumentTypeList |
|---|
| ResultGetDocumentTypeList |
|---|
|
ResultGetDocumentTypeList(hereda de ResultError) | documentTypeList | List<DocumentTypeList> | Lista de tipos de documento devueltos por el servicio |
Códigos de error Los errores de la invocación se encapsulan en ResultGetDocumentTypeList Código | Nombre | Descripción |
|---|
130 | ERROR_BASEDATOS_CSVPAPIRO | Error al conectar con la base de datos CCSV. | 718 | ERROR_GET_HIGHLIGHT | No existe ningún tipo de documento destacado para ese modelo de metadatos. | 130 | ERROR_BASEDATOS_CSVPAPIRO | Error al conectar con la base de datos CCSV. | 801 | GENERIC_ERROR | Error genérico procesando la petición. |
Ejemplo de invocación Invocación| 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());
} |
|
...
| Expand |
|---|
|
Signatura ResultGetDocumentXml getDocumentXml(ParamGetDocumentXml paramGetDocumentXml). Parámetros de invocación Nombre | Tipo | Obligatorio | DescripriciónDescripción |
|---|
ParamGetDocumentXml (hereda de ParamBase) | id | String | Si(1) | Identificador del documento en Documentum. | csv | String | Si(1) | Código seguro de verificación del documento en Documentum. |
NOTA: En caso de indicar el id no se deberá indicar el csv y viceversa.(1) Parámetros de respuesta Nombre | Tipo | Descripción |
|---|
| Anchor |
|---|
| ResultGetDocumentXml |
|---|
| ResultGetDocumentXml |
|---|
|
ResultGetDocumentXml(hereda de ResultError) | base64 | String | String en base64 del fichero xml. | nombre | String | Nombre por defecto del fichero resultante. |
Códigos de error Los errores de la invocación se encapsulan en ResultGetDocumentXml Código | Nombre | Descripción |
|---|
156 | ERROR_CSV_E_ID_NULOS | Se ha producido un error con PAPIRO. | 127 | ERROR_CSV_NOEXISTE | No existe documento con el CSV especificado. | 131 | ERROR_GENERICO_PAPIRO | Se ha producido un error con PAPIRO. | 101 | ERROR_CONEXION_PAPIRO | Error de conexión con documentum. | 801 | GENERIC_ERROR | Error genérico procesando la petición. | 733 | ERROR_DOCUMENTO_SUSTITUIDO | El documento ha sido anulado y sustituido por el documento: CSVXXXXXXXXXXXXXBENT | 732 | ERROR_DOCUMENTO_ANULADO | No se puede recuperar un documento anulado |
Ejemplo de invocación Invocación| 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());
} |
|
...
| Expand |
|---|
|
Signatura ResultUpdateMetadata updateMetadata(ParamUpdateMetadata paramUpdateMetadata). Parámetros de invocación Nombre | Tipo | Obligatorio | DescripriciónDescripción |
|---|
ParamUpdateMetadata(hereda de ParamBase) | id | String | Si(1) | Identificador del documento en Documentum. | csv | String | Si(1) | Código seguro de verificación del documento en Documentum. | newMetadata | HashMap<String,Object> | Si | Contiene los metadatos a actualizar. | addValues | boolean | Si | Indica si los valores se añaden a los existentes: true o se sustituyen los existentes por los que se pasan: false. Solo para metadatos repetitivos. | traceData | TraceData | Si | Contiene los datos de la traza de los cambios que se realizan. |
NOTA: En caso de indicar el id no se deberá indicar el csv y viceversa.(1) Parámetros de respuesta Nombre | Tipo | Descripción |
|---|
| 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. | 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 NIF del solicitante del servicio | 190 | ERROR_INTERNALACCESS_NOTALLOWED | No está permitido el acceso del nif 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 |
|---|
| 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());
} |
|
...
| Expand |
|---|
|
Signatura ResultDeleteMetadata deleteMetadata(ParamDeleteMetadata paramDeleteMetadata). Parámetros de invocación Nombre | Tipo | Obligatorio | DescripriciónDescripció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 posición del metadato repetitivo que queremos borrar. |
NOTA: En caso de indicar el id no se deberá indicar el csv y viceversa.(1) Parámetros de respuesta Nombre | Tipo | Descripción |
|---|
| 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 NIF del solicitante del servicio | 190 | ERROR_INTERNALACCESS_NOTALLOWED | No está permitido el acceso del nif 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 |
|---|
| 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 |
|---|
|
Signatura ResultCreateRelationship createRelationship(ParamCreateRelationship paramCreateRelationship). Parámetros de invocación Nombre | Tipo | Obligatorio | DescripriciónDescripción |
|---|
ParamCreateRelationship (hereda de ParamBase) | idParent | String | Si(1) | Identificador del documento padre de la relación en Documentum. | csvParent | String | Si(1) | Csv del documento padre de la relación. | idChild | String | Si(2) | Identificador del documento hijo de la relación en
Documentum. | csvChild | String | Si(2) | Csv del documento hijo de la relacionrelación. | relationship | DocumentRelation | si | Datos propios de la relación. |
NOTA : en caso de indicar el id del documento padre no habrá que indicar el csv y viceversa.(1) NOTA 2: en caso de indicar el id del documento hijo no habrá que indicar el csv y viceversa.(2) Parámetros de respuesta Nombre | Tipo | Descripción |
|---|
| Anchor |
|---|
| ResultCreateRelationship |
|---|
| ResultCreateRelationship |
|---|
|
ResultCreateRelationship(hereda de ResultError) |
Códigos de error Los errores de la invocación se encapsulan en ResultCreateRelationship Código | Nombre | Descripción |
|---|
149 | ERROR_RELACION_IDPADRE_NULO | Faltan los parámetros para identificar al documento Padre. | 150 | ERROR_RELACION_IDHIJO_NULO | Faltan los parámetros para identificar al documento Hijo | 151 | ERROR_RELACION_DATOS_NULO | Falta el parámetro con la información de la relación | 127 | ERROR_CSV_NOEXISTE | No existe documento con el CSV especificado | 131 | ERROR_GENERICO_PAPIRO | Se ha producido un erro con PAPIRO | 800 | ERROR_BASEDATOS_CSV | Error al conectar con la Base de Datos CSV | 158 | ERROR_VERIFY_NOT_VALUELIST | El valor indicado no está entre los valores válidos para ese metadato | 801 | GENERIC_ERROR | Error genérico procesando la petición. | 733 | ERROR_DOCUMENTO_SUSTITUIDO | El documento ha sido anulado y sustituido por el documento: CSVXXXXXXXXXXXXXBENT | 732 | ERROR_DOCUMENTO_ANULADO | No se puede recuperar un documento anulado |
Ejemplo de invocación Invocación| 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());
} |
|
...
| Expand |
|---|
|
Signatura ResultCreateRelationships createRelationships(ParamCreateRelationships paramCreateRelationships). Parámetros de invocación Nombre | Tipo | Obligatorio | DescripriciónDescripció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 relacionrelación. | relationship | DocumentRelation | Si | Datos propios de la relación. |
NOTA : en caso de indicar el id del documento padre no habrá que indicar el csv y viceversa.(1) NOTA 2: en caso de indicar el id del documento hijo no habrá que indicar el csv y viceversa.(2) Parámetros de respuesta Nombre | Tipo | Descripción |
|---|
| 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 |
|---|
| 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 |
|---|
|
Signatura ResultDeleteRelationship deleteRelationship (ParamDeleteRelationship paramDeleteRelationship). Parámetros de invocación Nombre | Tipo | Obligatorio | DescripriciónDescripción |
|---|
ParamDeleteRelationship(hereda de ParamBase) | idParent | String | Si(1) | Identificador del documento padre de la relación en Documentum. | csvParent | String | Si(1) | Csv del documento padre de la relación. | idChild | String | Si(2) | Identificador del documento hijo de la relación en Documentum. | csvChild | String | Si(2) | Csv del documento hijo de la relación. |
NOTA : en caso de indicar el id del documento padre no habrá que indicar el csv y viceversa.(1) NOTA 2: en caso de indicar el id del documento hijo no habrá que indicar el csv y viceversa.(2) Parámetros de respuesta Nombre | Tipo | Descripción |
|---|
| Anchor |
|---|
| ResultDeleteRelationship |
|---|
| ResultDeleteRelationship |
|---|
|
ResultDeleteRelationship(hereda de ResultError) |
Códigos de error Los errores de la invocación se encapsulan en ResultCreateRelationships Código | Nombre | Descripción |
|---|
149 | ERROR_RELACION_IDPADRE_NULO | Faltan los parámetros para identificar al documento Padre. | 150 | ERROR_RELACION_IDHIJO_NULO | Faltan los parámetros para identificar al documento Hijo | 127 | ERROR_CSV_NOEXISTE | No existe documento con el CSV especificado | 131 | ERROR_GENERICO_PAPIRO | Se ha producido un erro con PAPIRO | 800 | ERROR_BASEDATOS_CSV | Error al conectar con la Base de Datos CSV | 801 | GENERIC_ERROR | Error genérico procesando la petición. | 733 | ERROR_DOCUMENTO_SUSTITUIDO | El documento ha sido anulado y sustituido por el documento: CSVXXXXXXXXXXXXXBENT | 732 | ERROR_DOCUMENTO_ANULADO | No se puede recuperar un documento anulado |
Ejemplo de invocación Invocación| 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());
} |
|
...
| Expand |
|---|
|
Signatura ResultGetRelatedDocuments getRelatedDocuments(ParamGetRelatedDocuments paramGetRelatedDocuments). Parámetros de invocación Nombre | Tipo |
| DescripriciónDescripción |
|---|
ParamGetRelatedDocuments(hereda de ParamBase) | id | String | Si(1) | Id del documento en Documentum cuyas relaciones queremos obtener. | csv | String | Si(1) | CSV del documento cuyas relaciones queremos obtener. | role | String[] | No | Rol de las relaciones que queremos obtener. | dateStart | String | No | Fecha de inicio de la búsqueda que nos indicará si debemos incluir esa relación dentro de los resultados. | dateEnd | String | No | Fecha de fin de la búsqueda que nos indicará si debemos incluir esa relación dentro de los resultados. | addContent | boolean | Si | Indica si se añaden los contenidos de los documentos. | metadataNames | String[] | No | Nombres de los metadatos que queremos que nos muestre del el objeto Document de vuelta. | searchType | DocumentRelationSearchType | Si | Tipo de búsqueda a realizar: indica si queremos recuperar los documentos hijos relacionados o los documentos padre relacionados. |
NOTA : en caso de indicar el id del documento no habrá que indicar el csv y viceversa.(1) Parámetros de respuesta Nombre | Tipo | Descripción |
|---|
| Anchor |
|---|
| ResultGetRelatedDocuments |
|---|
| ResultGetRelatedDocuments |
|---|
|
ResultGetRelatedDocuments(hereda de ResultError) | documentTreeNodes | DocumentTreeNode | Array de documentos relacionados encontrados con los datos de la relación |
Códigos de error Los errores de la invocación se encapsulan en ResultGetRelatedDocuments Código | Nombre | Descripción |
|---|
152 | ERROR_RELACION_ID_NULO | Faltan los parámetros para identificar el documento cuyas relaciones se desean buscar | 127 | ERROR_CSV_NOEXISTE | No existe documento con el CSV especificado | 131 | ERROR_GENERICO_PAPIRO | Se ha producido un error con PAPIRO | 153 | ERROR_RELACION_TIPOBUSQUEDA_NULO | Falta el parámetro que indica si se deben buscar los documentos hijos relacionados o los documentos padre relacionados | 148 | ERROR_DOCUMENTOS_RELACIONADOS | No se han encontrado documentos relacionados para el documento seleccionado. | 800 | ERROR_BASEDATOS_CSV | Error al conectar con la Base de Datos CSV | 191 | ERROR_INTEGRATIONAPPLICATION | Error al recuperar la información de la integración de aplicaciones. | 190 | ERROR_INTERNALACCESS_NOTALLOWED | No está permitido el acceso del nif NIF solicitante al documento indicado | 189 | ERROR_INTERNALACCESSCONTROL_NIFINVALID | Debe especificar el nif 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 |
|---|
| 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());
} |
|
...
| Expand |
|---|
|
Signatura ResultGetAllRelatedDocuments getAllRelatedDocuments(ParamGetAllRelatedDocuments paramGetAllRelatedDocuments). Parámetros de invocación Nombre | Tipo | Obligatorio | DescripriciónDescripción |
|---|
ParamGetAllRelatedDocuments(hereda de ParamBase) | id | String | Si(1) | Id del documento en Documentum cuyas relaciones queremos obtener. | csv | String | si(1) | CSV del documento cuyas relaciones queremos obtener. | role | String[] | No | Rol de las relaciones que queremos obtener. | dateStart | String | No | Fecha de inicio de la búsqueda que nos indicará si debemos incluir esa relación dentro de los resultados. | dateEnd | String | No | Fecha de fin de la búsqueda que nos indicará si debemos incluir esa relación dentro de los resultados. | addContent | boolean | Si | Indica si se añaden los contenidos de los documentos. | metadataNames | String[] | No | Nombres de los metadatos que queremos que nos muestre del el objeto Document de vuelta. | searchType | DocumentRelationSearchType | Si | Tipo de búsqueda a realizar: indica si queremos recuperar los documentos hijos relacionados o los documentos padre relacionados. |
NOTA : en caso de indicar el id del documento no habrá que indicar el csv y viceversa.(1) Parámetros de respuesta Nombre | Tipo | Descripción |
|---|
| Anchor |
|---|
| ResultGetRelatedDocuments |
|---|
| ResultGetRelatedDocuments |
|---|
|
ResultGetAllRelatedDocuments(hereda de ResultError) | documentTreeNodes | DocumentTreeNode | Array de documentos relacionados encontrados con los datos de la relación |
Códigos de error Los errores de la invocación se encapsulan en ResultGetAllRelatedDocuments Código | Nombre | Descripción |
|---|
152 | ERROR_RELACION_ID_NULO | Faltan los parámetros para identificar el documento cuyas relaciones se desean buscar | 127 | ERROR_CSV_NOEXISTE | No existe documento con el CSV especificado | 131 | ERROR_GENERICO_PAPIRO | Se ha producido un error con PAPIRO | 153 | ERROR_RELACION_TIPOBUSQUEDA_NULO | Falta el parámetro que indica si se deben buscar los documentos hijos relacionados o los documentos padre relacionados | 148 | ERROR_DOCUMENTOS_RELACIONADOS | No se han encontrado documentos relacionados para el documento seleccionado. | 800 | ERROR_BASEDATOS_CSV | Error al conectar con la Base de Datos CSV | 191 | ERROR_INTEGRATIONAPPLICATION | Error al recuperar la información de la integración de aplicaciones. | 190 | ERROR_INTERNALACCESS_NOTALLOWED | No está permitido el acceso del nif NIF solicitante al documento indicado | 189 | ERROR_INTERNALACCESSCONTROL_NIFINVALID | Debe especificar el nif 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 |
|---|
| 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 |
|---|
|
Signatura ResultAddAgentRelationship addAgentRelationship(ParamAddAgentRelationship paramAddAgentRelationship). Parámetros de invocación Nombre | Tipo | Obligatorio | DescripriciónDescripción |
|---|
ParamAddAgentRelationship(hereda de ParamBase) | csv | String | Si(1) | Codigo Código csv asociado al documento en el que se quiere añadir la relacionrelación. | id | String | Si(1) | Identificador del documento en el que se quiere agregar la relacionrelación. | agentRelationship | AgentRelationship | Si | Contiene todos los datos de la relación a crear | traceData | TraceData | Si | Datos sobre la traza de la agregación de una nueva relacionrelació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 |
|---|
| ResultAddAgentRelationship |
|---|
| ResultAddAgentRelationship |
|---|
|
ResultAddAgentRelationship(hereda de ResultError) |
Códigos de error Los errores de la invocación se encapsulan en ResultAddAgentRelationship Código | Nombre | Descripción |
|---|
156 | ERROR_CSV_E_ID_NULOS | Debe especificar el id de Documentum o el CSV | 182 | ERROR_AGENTRELATIONSHIPNULO | Debe especificar algún agentRelationship con los datos de la relación de agente | 127 | ERROR_CSV_NOEXISTE | No existe documento con el CSV especificado | 158 | ERROR_VERIFY_NOT_VALUELIST | El valor indicado no está entre los valores válidos para ese metadato. | 191 | ERROR_INTEGRATIONAPPLICATION | Error al recuperar la información de la integración de aplicaciones. | 190 | ERROR_INTERNALACCESS_NOTALLOWED | No está permitido el acceso del nif solicitante al documento indicado. | 189 | ERROR_INTERNALACCESSCONTROL_NIFINVALID | Debe especificar el nif del solicitante del servicio. | 192 | ERROR_CONEXION_PAU | Se ha producido un error al realizar la conexión con PAU. | 141 | ERROR_CONEXION_SIU | Se ha producido un error al realizar la conexión con SIU . | 131 | ERROR_GENERICO_PAPIRO | Se ha producido un error con PAPIRO. | 101 | ERROR_CONEXION_PAPIRO | Error de conexión con documentum. | 801 | GENERIC_ERROR | Error genérico procesando la petición. | 733 | ERROR_DOCUMENTO_SUSTITUIDO | El documento ha sido anulado y sustituido por el documento: CSVXXXXXXXXXXXXXBENT | 732 | ERROR_DOCUMENTO_ANULADO | No se puede recuperar un documento anulado |
Ejemplo de invocación Invocación| 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());
} |
|
...
| Expand |
|---|
|
Signatura ResultAddAgentRelationships addAgentRelationships(ParamAddAgentRelationships paramAddAgentRelationships) Parámetros de invocación Nombre | Tipo | DescripriciónDescripción |
|---|
ParamAddAgentRelationship(hereda de ParamBase) | csv | String | Codigo Código csv asociado al documento en el que se quiere n añadir las relaciones. | id | String | Identificador del documento en el que se quieren agregar las relaciones. | agentRelationships | AgentRelationship[] | Contiene todos los datos de la relación a crear | traceData | TraceData | Datos sobre la traza de la creación de nuevas relaciones para el documento. |
NOTA : en caso de indicar el id del documento no habrá que indicar el csv y viceversa. Parámetros de respuesta Nombre | Tipo | Descripción |
|---|
| Anchor |
|---|
| ResultAddAgentRelationships |
|---|
| ResultAddAgentRelationships |
|---|
|
ResultAddAgentRelationships(hereda de ResultError) |
Códigos de error Los errores de la invocación se encapsulan en ResultAddAgentRelationships Código | Nombre | Descripción |
|---|
156 | ERROR_CSV_E_ID_NULOS | Debe especificar el id de Documentum o el CSV | 182 | ERROR_AGENTRELATIONSHIPNULO | Debe especificar algún agentRelationship con los datos de la relación de agente | 127 | ERROR_CSV_NOEXISTE | No existe documento con el CSV especificado | 158 | ERROR_VERIFY_NOT_VALUELIST | El valor indicado no está entre los valores válidos para ese metadato. | 191 | ERROR_INTEGRATIONAPPLICATION | Error al recuperar la información de la integración de aplicaciones. | 190 | ERROR_INTERNALACCESS_NOTALLOWED | No está permitido el acceso del nif NIF solicitante al documento indicado. | 189 | ERROR_INTERNALACCESSCONTROL_NIFINVALID | Debe especificar el nif 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 |
|---|
| 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 |
|---|
|
Signatura ResultDeleteAgentRelationship deleteAgentRelationship(ParamDeleteAgentRelationship paramDeleteAgentRelationship); Parámetros de invocación Nombre | Tipo | Obligatorio | DescripriciónDescripció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 relacionrelación. | agentRelationship | AgentRelationship | Si | Contiene todos los datos de la relación a borrar | traceData | TraceData | Si | Datos sobre la traza del borrado de la relación. |
NOTA : en caso de indicar el id del documento no habrá que indicar el csv y viceversa. Parámetros de respuesta Nombre | Tipo | Descripción |
|---|
| Anchor |
|---|
| ResultDeleteAgentRelationship |
|---|
| ResultDeleteAgentRelationship |
|---|
|
ResultDeleteAgentRelationship(hereda de ResultError) |
Códigos de error Los errores de la invocación se encapsulan en ResultDeleteAgentRelationship Código | Nombre | Descripción |
|---|
156 | ERROR_CSV_E_ID_NULOS | Debe especificar el id de Documentum o el CSV | 182 | ERROR_AGENTRELATIONSHIPNULO | Debe especificar algún agentRelationship con los datos de la relación de agente | 183 | ERROR_AGENTRELATIONSHIPIDNULO | Debe especificar el identificador dentro del parámetro agentRelationship | 127 | ERROR_CSV_NOEXISTE | No existe documento con el CSV especificado | 185 | ERROR_AGENTRELATIONSHIP_NOEXIST | No existe para el documento indicado esa relación
agente | 191 | ERROR_INTEGRATIONAPPLICATION | Error al recuperar la información de la integración de aplicaciones. | 190 | ERROR_INTERNALACCESS_NOTALLOWED | No está permitido el acceso del nif NIF solicitante al documento indicado. | 189 | ERROR_INTERNALACCESSCONTROL_NIFINVALID | Debe especificar el nif 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 |
|---|
| 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 |
|---|
|
Signatura ResultUpdateAgentRelationship updateAgentRelationship(ParamUpdateAgentRelationship paramUpdateAgentRelationship); Parámetros de invocación Nombre | Tipo | Obligatorio | DescripriciónDescripción |
|---|
ParamUpdateAgentRelationship(hereda de ParamBase) | csv | String | Si(1) | Código csv asociado al documento en el que se va a modificar la relacionrelación. | id | String | Si(1) | Identificador del documento en el que se va a modificar la relación. | agentRelationship | AgentRelationship | Si | Contiene todos los datos de la relación a borrar | traceData | TraceData | Si | Datos sobre la traza del borrado de la relación. |
NOTA : en caso de indicar el id del documento no habrá que indicar el csv y viceversa.(1) Parámetros de respuesta Nombre | Tipo | Descripción |
|---|
| Anchor |
|---|
| ResultUpdateAgentRelationship |
|---|
| ResultUpdateAgentRelationship |
|---|
|
ResultUpdateAgentRelationship(hereda de ResultError) |
Códigos de error Los errores de la invocación se encapsulan en ResultUpdateAgentRelationship Código | Nombre | Descripción |
|---|
156 | ERROR_CSV_E_ID_NULOS | Debe especificar el id de Documentum o el CSV | 182 | ERROR_AGENTRELATIONSHIPNULO | Debe especificar algún agentRelationship con los datos de la relación de agente | 127 | ERROR_CSV_NOEXISTE | No existe documento con el CSV especificado | 158 | ERROR_VERIFY_NOT_VALUELIST | Debe especificar el identificador dentro del parámetro agentRelationship. | 191 | ERROR_INTEGRATIONAPPLICATION | Error al recuperar la información de la integración de aplicaciones. | 190 | ERROR_INTERNALACCESS_NOTALLOWED | No está permitido el acceso del nif NIF solicitante al documento indicado. | 189 | ERROR_INTERNALACCESSCONTROL_NIFINVALID | Debe especificar el nif 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 |
|---|
| 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 |
|---|
|
Signatura ResultGetAgentRelationship getAgentRelationship(ParamGetAgentRelationship paramGetAgentRelationship);; Parámetros de invocación Nombre | Tipo | Obligatorio | DescripriciónDescripción |
|---|
ParamGetAgentRelationship(hereda de ParamBase) | csv | String | Si(1) | Código csv asociado al documento del que se quiere recuperar una relación | id | String | Si(1) | Identificador del documento del que se quiere recuperar una relación | role | String | Si(2) | Contiene el rol que se quiere recuperar. | identificationNumber | String | Si(2) | Código de identificación del agente: Número de
NIF, |
NOTA : en caso de indicar el id del documento no habrá que indicar el csv y viceversa.(1) NOTA 2 : Se debe indicar por lo menos el role o el identificación number para que se identifique una única relación de agente.(2) Parámetros de respuesta Nombre | Tipo | Descripción |
|---|
| Anchor |
|---|
| ResultGetAgentRelationship |
|---|
| ResultGetAgentRelationship |
|---|
|
ResultGetAgentRelationship(hereda de ResultError) | agentRelationship | AgentRelationship | Objeto AgentRelationship con el contenido de la relación agente recuperado |
Códigos de error Los errores de la invocación se encapsulan en ResultAddAgentRelationships Código | Nombre | Descripción |
|---|
156 | ERROR_CSV_E_ID_NULOS | Debe especificar el id de Documentum o el CSV | 184 | ERROR_ADD_ROLEORIDENTIFICATIONNUMBER | Debe especificar otro criterio de búsqueda, ya que existen varias relaciones que cumplen el indicado | 127 | ERROR_CSV_NOEXISTE | No existe documento con el CSV especificado | 131 | ERROR_GENERICO_PAPIRO | Se ha producido un error con PAPIRO. | 101 | ERROR_CONEXION_PAPIRO | Error de conexión con documentum. | 801 | GENERIC_ERROR | Error genérico procesando la petición. | 733 | ERROR_DOCUMENTO_SUSTITUIDO | El documento ha sido anulado y sustituido por el documento: CSVXXXXXXXXXXXXXBENT | 732 | ERROR_DOCUMENTO_ANULADO | No se puede recuperar un documento anulado |
Ejemplo de invocación Invocación| 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());
} |
|
...
| Expand |
|---|
|
Signatura ResultGetAgentRelationships getAgentRelationships(ParamGetAgentRelationships paramGetAgentRelationships) Parámetros de invocación Nombre | Tipo | Obligatorio | DescripriciónDescripció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 | AgentRelationship[] | Array de objetos AgentRelationship con el contenido de las relaciones agente recuperadas |
Códigos de error Los errores de la invocación se encapsulan en ResultGetAgentRelationships Código | Nombre | Descripción |
|---|
156 | ERROR_CSV_E_ID_NULOS | Debe especificar el id de Documentum o el CSV | 127 | ERROR_CSV_NOEXISTE | No existe documento con el CSV especificado | 131 | ERROR_GENERICO_PAPIRO | Se ha producido un error con PAPIRO. | 101 | ERROR_CONEXION_PAPIRO | Error de conexión con documentum. | 801 | GENERIC_ERROR | Error genérico procesando la petición. | 733 | ERROR_DOCUMENTO_SUSTITUIDO | El documento ha sido anulado y sustituido por el documento: CSVXXXXXXXXXXXXXBENT | 732 | ERROR_DOCUMENTO_ANULADO | No se puede recuperar un documento anulado |
Ejemplo de invocación Invocación| 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());
} |
|
...
| Expand |
|---|
|
Signatura ResultGenerateIframeToken generateIframeToken(ParamGenerateIframeToken paramGenerateIframeToken) Parámetros de invocación Nombre | Tipo | Obligatorio | DescripriciónDescripció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 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());
} |
|
...
| Expand |
|---|
|
Signatura ResultValidateIframeToken validateIframeToken(ParamValidateIframeToken paramValidateIframeToken); Parámetros de invocación Nombre | Tipo | Obligatorio | DescripriciónDescripció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 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());
} |
|
...
| Expand |
|---|
|
Signatura ResultGetDocumentSubtypeList getDocumentSubtypeList(ParamGetDocumentSubtypeList paramDocumentSubtypeList); Parámetros de invocación Nombre | Tipo | Obligatorio | DescripriciónDescripción |
|---|
ParamGetDocumentSubtypeList (hereda de ParamBase) | documentTypeName | String | Si | Nombre del tipo de documento. |
Parámetros de respuesta Nombre | Tipo | Descripción |
|---|
ResultGetDocumentSubtypeList (hereda de ResultError) | documentSubtypeList | List<DocumentSubtypeList> | Listado de los subtipos de documentos que se han recuperado a partir de los parámetros de búsqueda. |
Códigos de error Los errores de la invocación se encapsulan en ResultGetDocumentSubtypeList Código | Nombre | Descripción |
|---|
| ERROR_GET_DOCUMENTSUBTYPELIST | No existe ningún subtipo de documento para ese tipo de documento. | 130 | ERROR_BASEDATOS_CSVPAPIRO | Error al conectar con la Base de Datos CSV. | 801 | GENERIC_ERROR | Error genérico procesando la petición |
Ejemplo de invocación Invocación| 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)
...
Se recomienda usar el método updateMetadata ya que puede usarse independientemente del tipo de metadato que se intenta actualizar.
Servicio ISendAdminFileCloudWSPortType
El protocolo de Remisión en la Nube pretende ser un estándar para el intercambio de expedientes electrónicos en formato ENI (Esquema Nacional de Interoperabilidad) entre dos administraciones públicas cualesquiera, sean estas administrativas o judiciales.
...
| Expand |
|---|
|
Signatura ResultCreateDocumentXml createDocumentXml(ParamCreateDocumentXml paramCreateDocumentXml). Parámetros de invocación Nombre | Tipo | Obligatorio | DescripriciónDescripción |
|---|
ParamCreateDocumentXml (hereda de ParamBase) | xml | DataHandler | Si | Xml del documento | agent | Agent | Si | Relación con meta-dato estructurado de tipo agente | name | String | No | Nombre del documento | procedureCode | String | No | Código de procedimiento |
Parámetros de respuesta Nombre | Tipo | Descripción |
|---|
| 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 | Extensión del documento que se ha creado. |
Códigos de error Los errores de la invocación se encapsulan en ResultCreateDocumentXml Código | Nombre | Descripción |
|---|
203 | ERROR_DATAHANDLER_ARRAYBYTE_CSV | Error al pasar dataHandler a ArrayByte | 1208 | ERROR_PARSE_XML | Hubo un error al leer los datos recibidos | 101 | ERROR_CONEXION_PAPIRO | Error de conexión con documentum | 1214 | ERROR_INDEX_FILE_EXIST | El documento eni ya existe. |
Ejemplo de invocación Invocación| 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());
} |
|
...
| Expand |
|---|
|
Signatura ResultCreateIndexXml createIndexXml(ParamCreateIndexXml paramCreateIndexXml). Parámetros de invocación Nombre | Tipo | Obligatorio | DescripriciónDescripición |
|---|
ParamCreateIndexXml (hereda de ParamBase) | xml | DataHandler | Si | Xml del indiceíndice. | agent | Agent | Si | Relación con metadato estructurado de tipo agente | name | String | No | Nombre del documento indiceíndice. | procedureCode | String | No | Código de procedimiento | type | String | Si | Tipo del expediente donde se crea el indiceíndice. | number | String | Si | Numero del expediente donde se crea el indiceíndice. | description | String | Si | Descripcion Descripción del expediente donde se crea el indiceíndice. |
Parámetros de respuesta Nombre | Tipo | Descripción |
|---|
| Anchor |
|---|
| ResultCreateIndexXml |
|---|
| ResultCreateIndexXml |
|---|
|
ResultCreateIndexXml (hereda de ResultError) | csv | String | Código csv asociado al documento indice índice que se ha creado. | name | String | Nombre del documento indice índice que se ha creado. | extension | String | Extension Extensión del documento indice índice que se ha creado. |
| Anchor |
|---|
| ResultCreateIndexXml |
|---|
| ResultCreateIndexXml |
|---|
|
Códigos de errorLos errores de la invocación se encapsulan en ResultCreateIndexXml Código | Nombre | Descripción |
|---|
203 | ERROR_DATAHANDLER_ARRAYBYTE_CSV | Error al pasar dataHandler a ArrayByte | 1208 | ERROR_PARSE_XML | Hubo un error al leer los datos recibidos | 101 | ERROR_CONEXION_PAPIRO | Error de conexión con documentum | 1214 | ERROR_INDEX_FILE_EXIST | El documento eni ya existe. |
Ejemplo de invocación Invocación| 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());
}
|
|
...
| Expand |
|---|
|
Signatura void prepareXmlToInside(ParamPrepareXmlToInside paramPrepareXmlToInside) Parámetros de invocación Nombre | Tipo | Obligatorio | DescripriciónDescripció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 Código csv adjunto al documento que se prepara para enviar. | Id de la peticion | String | No | Id de la peticiopetición. | description | String | No | Descripcion Descripción del expediente donde se crea el indiceíndice. | motivacion | String | No | Motivación. Maximo Máximo 256 | plazoDisponibilidad | Date | No | Fecha limite hata hasta la que el expediente//documento esta disponible | flagAdminFileJustice | boolean | Si | Indica si se remite o no a justicia | paramSendJustice | ParamSendJustice | Si | Parametros Parámetros adicionales para remitir a justicia. |
NOTA: En caso de indicar como true el parametro flagAdminFileJustice habra que indicar el objeto paramSendJustice. Parámetros de respuesta Al ser un método void , no devolverá nada. Códigos de error Los errores de la invocación se encapsulan en ResultGetAdministrativeFile Código | Nombre | Descripción |
|---|
1200 | ERROR_INSIDE_ALTA_EXPEDIENTE | Se ha producido un error con el servicio Inside | 193 | ERROR_BASEDATOS_CCSV | Error al conectar con la Base de Datos CSVs | 801 | GENERIC_ERROR | Error genérico procesando la petición |
Ejemplo de invocación Invocación| 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());
} |
|
...