En este apartado se exponen los servicios para integradores junto con parámetros de invocación, respuesta, errores y ejemplo de código java.
Servicio IAdministrativeFileServicePortType
A continuación se muestran todos los métodos referentes a la administración de expedientes. Los métodos que a continuación se definen permiten realizar las operaciones de apertura, recuperación, borrado de expedientes así como las operaciones necesarias para la incorporación de documentos o subexpedientes al expediente.
Métodos para la gestión de expedientes
Método 'getAdministrativeFile'
...
| Expand |
|---|
|
Signatura ResultRegenerateAdministrativeFileIndex regenerateAdministrativeFileIndex(ParamRegenerateAdministrativeFileIndex paramRegenerateAdministrativeFileIndex); Parámetros de invocación Nombre | Tipo | Obligatorio | Descriprición |
|---|
ParamRegenerateAdministrativeFileIndex (hereda de CCSV_3.5.0_Manual de integración#ParamBase) | csv | String | Si(1) | CSV del expediente del expediente del que se va a regenerar el indice. | id | String | Si(1) | Identificador del expediente del que se va a regenerar el indice. | includeAdminFile | boolean | No(2) | Indica si se desea recuperar el objeto expediente con el índice regenerado | attachIndexSignature | boolean | No(2) | Indica si se desea recuperar la firma asociada al índice |
NOTA: Si se consulta por csv no se rellena el campo id y viceversa.(1) NOTA 2 : Si no se indican por defecto son falsos.(2) Parámetros de respuesta Códigos de error Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#ResultRegenerateAdministrativeFileIndex Código | Nombre | Descripción |
|---|
1002 | ERROR_DOCUMENTMETADATA | Error del DocumentMetadataManager | 801 | GENERIC_ERROR | Error genérico procesando la petición. |
Ejemplo de invocación Invocación| Code Block |
|---|
ParamRegenerateAdministrativeFileIndex paramRegenerateAdministrativeFileIndex = new ParamRegenerateAdministrativeFileIndex();
paramRegenerateAdministrativeFileIndex.setId("0906fca3801922bb");
paramRegenerateAdministrativeFileIndex.setIncludeAdminFile(true);
ResultRegenerateAdministrativeFileIndex result = ccsvClient.regenerateAdministrativeFileIndex(paramRegenerateAdministrativeFileIndex);
if(result.getReturnCode().equals(ReturnCode.OK){
AdministrativeFile adminFile = result.getAdminFile();
}else{
log.error(result.getErrorCode()+":"+result.getErrorMessage());
} |
|
Métodos para la gestión de los contenidos de los expedientes.
Método 'addDocumentToAdminFile'
...
| Expand |
|---|
|
Signatura ResultMoveDocumentToRecycleFolder moveDocumentToRecycleFolder(ParamMoveDocumentToRecycleFolder paramMoveDocumentToRecycleFolder); Parámetros de invocación Nombre | Tipo | Obligatorio | Descriprición |
|---|
ParamMoveDocumentToRecycleFolder(hereda de CCSV_3.5.0_Manual de integración#ParamBase) | adminFileCsv | String | Si(1) | csv del expediente donde se encuentra el documento a mover, en caso de que el documento esté directamente en el expediente | adminFileId | String | Si(1) | Identificador en Documentum del expediente donde se encuentra el documento a mover, en caso de que el documento esté directamente en el expediente | documentCsv | String | Si(2) | csv del documento a mover | documentId | String | Si(2) | Identificador en Documentum del documento a mover | reasonToMove | String | Si | Razón por la que se solicita el movimiento a la papelera de reciclaje. |
NOTA: Si se rellena el adminFileCsv no se rellena el campo adminFileId y viceversa.(1) NOTA 2: Si se rellena el documentCsv no se rellena el campo documentId y viceversa.(2) Parámetros de respuesta Códigos de error Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#ResultMoveDocumentToRecycleFolder Código | Nombre | Descripción |
|---|
1017 | ERROR_ADMINFILE_CSV_E_ID_NULOS | Debe especificar el id o el CSV del expediente. | 1039 | ERROR_ADMINFILE_NIF_USER_REQUESTING_MOVE_NULL | El nif del usuario que solicita el movimiento
es obligatorio | 1007 | ERROR_ADMINFILE_CSV_E_ID_DOC_CONTENIDO_NULOS | Debe especificar el id o el CSV del documento contenido del expediente | 1040 | ERROR_ADMINFILE_REASON_TO_MOVE_NULL | La razón por la que solicita el movimiento
es obligatoria | 1029 | ERROR_NOTEXIST_DOCINADMINFILE | No existe ese documento en el expediente especificado | 1002 | ERROR_DOCUMENTMETADATA | Error del DocumentMetadataManager. | 801 | GENERIC_ERROR | Error genérico procesando la petición. |
Ejemplo de invocación Invocación| Code Block |
|---|
ParamMoveDocumentToRecycleFolder paramMoveDocumentToRecycleFolder = new ParamMoveDocumentToRecycleFolder();
paramMoveDocumentToRecycleFolder.setAdminFileCsv("CCSV54641878471CCSV");
paramMoveDocumentToRecycleFolder.setNif("00000000T");
ResultMoveDocumentToRecycleFolder result = ccsvClient.moveDocumentToRecycleFolder(paramMoveDocMétodos para la gestión de carpetas.umentToRecycleFolder);
if(result.getReturnCode().equals(ReturnCode.ERROR){
log.error(result.getErrorCode()+":"+result.getErrorMessage());
} |
|
Métodos para la gestión de carpetas.
Método 'createAdministrativeFileFolder'
...
| Expand |
|---|
|
Signatura ResultLastAddedContents lastAddedContents(ParamLastAddedContents paramLastAddedContents); Parámetros de invocación Nombre | Tipo | Obligatorio | Descriprición |
|---|
ParamLastAddedContents (hereda de CCSV_3.5.0_Manual de integración#ParamBase) | csv | String | Si(1) | CSV del expediente. | id | String | Si(1) | Identificador del expediente. | dateStart | Date | No | Devolverá expedientes, documentos y carpetas, añadidos a partir de esa fecha | metadata | String[] | No | Array de nombres de los metadatos que deseamos recuperar | includeContent | boolean | No | Indica si se desean recuperar los contenidos de los documentos del expediente |
NOTA: Si se rellena el csv no se rellena el campo id y viceversa.(1) Parámetros de respuesta Códigos de error Los errores de la invocación se encapsulan en ResultLastAddedContents Código | Nombre | Descripción |
|---|
1017 | ERROR_ADMINFILE_CSV_E_ID_NULOS | Debe especificar el id o el CSV del expediente. | 1002 | ERROR_DOCUMENTMETADATA | Error del DocumentMetadataManager. | 801 | GENERIC_ERROR | Error genérico procesando la petición. |
Ejemplo de invocación Invocación| Code Block |
|---|
ParamLastAddedContents paramLastAddedContents = new ParamLastAddedContents();
paramLastAddedContents.setApplicationId("CCSV");
paramLastAddedContents.setDateStart(Calendar.getInstance().getTime());//fecha desde la que se desean recoger los datos.
paramLastAddedContents.setIncludeContent(true);
paramLastAddedContents.setNif("00000000T");
ResultLastAddedContents result = ccsvClient.lastAddedContents(paramLastAddedContents);
if(result.getReturnCode().equals(ReturnCode.ERROR){
log.error(result.getErrorCode()+":"+result.getErrorMessage());
} |
|
A continuación se muestran todos los métodos referentes a la administración del modelo de metadatos existente o anteriores, la gestión de tipos de documentos y documentales y la administración de los metadatos existentes.
Método 'getMetadataModelList'
...
| Expand |
|---|
|
Signatura ResultUpdateMetadataModel updateMetadataModel(ParamUpdateMetadataModel paramUpdateMetadataModel). Parámetros de invocación Parámetros de respuesta Códigos de error Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#ResultDeleteMetadataModel Código | Nombre | Descripción |
|---|
701 | ERROR_METADATAMODELID_NOEXISTE | No existe un modelo de metadatos con el identificador especificado. | 702 | ERROR_METADATAMODELID_NULO | Debe especificar un metadataModelId. | 716 | ERROR_DELETE_METADATAMODEL_HISTORICAL | No se puede borrar un modelo de metadatos actual o que ya ha utilizado Papiro. | 801 | GENERIC_ERROR | Error genérico procesando la petición. |
Ejemplo de invocación Invocación| Code Block |
|---|
ParamDeleteMetadataModel paramDeleteMetadataModel = new ParamDeleteMetadataModel();
paramDeleteMetadataModel.setMetadataModelId(metadataModel.getMetadataModelId());
ResultDeleteMetadataModel result = cssvClient.getMetadataModelWs().deleteMetadataModel(paramDeleteMetadataModel);
if (result.getReturnCode().equals(ReturnCode.ERROR)){
log.error( result.getErrorCode()+":"+result.getErrorMessage());
} |
|
Métodos de tipos de documentos.
Método 'getDocumentTypeList'
...
| Expand |
|---|
|
Signatura ResultDeleteDocumentumType deleteDocumentumType(ParamDeleteDocumentumType paramDeleteDocumentumType). Parámetros de invocación Parámetros de respuesta Códigos de error Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#ResultDeleteDocumentumType Código | Nombre | Descripción |
|---|
701 | ERROR_METADATAMODELID_NOEXISTE | No existe un modelo de metadatos con el
identificador especificado | 702 | ERROR_METADATAMODELID_NULO | Debe especificar un metadataModelId. | 711 | ERROR_DELETE_DOCUMENTUMTYPE_DOCUMENTUMTYPE | Existe algún tipo documental hijo, asociado al tipo documental que ha intentado borrar. | 712 | ERROR_DELETE_DOCUMENTUMTYPE_DOCUMENTTYPE | Existe algún tipo de documento asociado al tipo documental que ha intentado borrar. | 713 | ERROR_DELETE_DOCUMENTUMTYPE_METADATATYPE | Existe algún metadato asociado al tipo documental que ha intentado borrar. | 714 | ERROR_DELETE_CLONED | No se puede borrar porque afecta una versión anterior. | 800 | ERROR_BASEDATOS_CSV | Error al conectar con la Base de Datos CSV. | 801 | GENERIC_ERROR | Error genérico procesando la petición. |
Ejemplo de invocación Invocación| Code Block |
|---|
ParamDeleteDocumentumType paramDeleteDocumentumType = new ParamDeleteDocumentumType();
paramDeleteDocumentumType.setDocumentumTypeId(documentumType.getDocumentumTypeId());
ResultDeleteDocumentumType result = cssvClient.getMetadataModelWs().deleteDocumentumType(paramDeleteDocumentumType);
if (result.getReturnCode().equals(ReturnCode.ERROR)){
log.error(result.getErrorCode()+":"+ result.getErrorMessage());
} |
|
Método 'getMetadataList'
...
Permite obtener la lista de metadatos de un tipo documental.
...
| Expand |
|---|
|
Signatura ResultDeleteMetadata deleteMetadata(ParamDeleteMetadata paramDeleteMetadata). Parámetros de invocación Parámetros de respuesta Códigos de error Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#ResultDeleteMetadata Código | Nombre | Descripción |
|---|
702 | ERROR_METADATAMODELID_NULO | Debe especificar un metadataModelId. | 714 | ERROR_DELETE_CLONED | No se puede borrar porque afecta una versión anterior | 800 | ERROR_BASEDATOS_CSV | Error al conectar con la Base de Datos CSV. | 801 | GENERIC_ERROR | Error genérico procesando la petición. |
Ejemplo de invocación Invocación| Code Block |
|---|
ParamDeleteMetadata paramDeleteMetadata = new ParamDeleteMetadata();
paramDeleteMetadata.setMetadataId(metadata.getMetadataId());
ResultDeleteMetadata result = cssvClient.getMetadataModelWs().deleteMetadata(paramDeleteMetadata);
if (result.getReturnCode().equals(ReturnCode.ERROR)){
log.error(result.getErrorCode()+":"+result.getErrorMessage());
} |
|
Método 'getMetadataValueList'
...
| Expand |
|---|
|
Signatura ResultDeleteMetadataValue deleteMetadataValue(ParamDeleteMetadataValue paramDeleteMetadataValue). Parámetros de invocación Parámetros de respuesta Códigos de error Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#ResultDeleteMetadataValue Código | Nombre | Descripción |
|---|
702 | ERROR_METADATAMODELID_NULO | Debe eMspecificar un metadataModelId. | 709 | ERROR_METADATAVALUEID_NOEXISTE | No existe un valor de metadato con el identificador especificado. | 800 | ERROR_BASEDATOS_CSV | Error al conectar con la Base de Datos CSV. | 801 | GENERIC_ERROR | Error genérico procesando la petición. |
Ejemplo de invocación Invocación| Code Block |
|---|
ParamDeleteMetadataValue paramDeleteMetadataValue = new ParamDeleteMetadataValue();
paramDeleteMetadataValue.setMetadataValueId(metadataId);
ResultDeleteMetadataValue result =
cssvClient.getMetadataModelWs().deleteMetadataValue(paramDeleteMetadataValue);
if (result.getReturnCode().equals(ReturnCode.ERROR)){
log.error(result.getErrorCode()+":"+result.getErrorMessage());
} |
|
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 |
|---|
|
ResultDeleteDocument deleteDocument(ParamDeleteDocument paramDeleteDocument). Parámetros de invocación Nombre | Tipo | Obligatorio | Descriprición |
|---|
ParamDeleteDocument(hereda de CCSV_3.5.0_Manual de integración#ParamBase) | id | String | Si(1) | Identificador del documento en el gestor documental Documentum | csv | String | Si(1) | Código Seguro de Verificación del documento que se quiere recuperar. |
NOTA : En caso de rellanar el id no habrá que rellenar el csv y viceversa.(1) Parámetros de respuesta Códigos de error Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#ResultDeleteDocument Código | Nombre | Descripción |
|---|
156 | ERROR_CSV_E_ID_NULOS | Debe especificar el identificador del documento o su CSV. | 191 | ERROR_INTEGRATIONAPPLICATION | Error al recuperar la información de la integración de aplicaciones. | 190 | ERROR_INTERNALACCESS_NOTALLOWED | No está permitido el acceso del nif solicitante al documento indicado. | 189 | ERROR_INTERNALACCESSCONTROL_NIFINVALID | Debe especificar el nif del solicitante del servicio | 192 | ERROR_CONEXION_PAU | Se ha producido un error al realizar la conexión con PAU. | 141 | ERROR_CONEXION_SIU | Se ha producido un error al realizar la conexión con PAU | 127 | ERROR_CSV_NOEXISTE | No existe documento con el CSV especificado | 131 | ERROR_GENERICO_PAPIRO | Se ha producido un error con PAPIRO | 130 | ERROR_BASEDATOS_CSVPAPIRO | Error al conectar con la base de datos CCSV | 2019 | ERROR_FILE_TOO_LARGE | El documento es demasiado grande. Puede descargarlo llamando al servicio web de descarga de documentos de VAJE. | 101 | ERROR_CONEXION_PAPIRO | Error de conexión con documentum | 801 | GENERIC_ERROR | Error genérico procesando la petición. |
Ejemplo de invocación Invocación| Code Block |
|---|
ParamDeleteDocument paramDeleteDocument = new ParamDeleteDocument();
paramDeleteDocument.setCsv("CSV3G2ZOOM5NGAG1CCSV");
ResultDeleteDocument result = ccsvClient.deleteDocument(paramDeleteDocument);
if(result.getReturnCode().equals(ReturnCode.ERROR){
log.error(result.getErrorCode()+":"+result.getErrorMessage());
} |
|
Métodos de gestión de enlaces de documentos.
Método 'createDocumentLink'
...
| Expand |
|---|
|
Signatura ResultDeleteDocumentLink deleteDocumentLink(ParamDeleteDocumentLink paramDeleteDocumentLink). Parámetros de invocación Nombre | Tipo | Obligatorio | Descriprición |
|---|
ParamDeleteDocumentLink(hereda de CCSV_3.5.0_Manual de integración#ParamBase) | csv | String | Si(1) | Csv del documento cuyo enlace se quiere borrar. | id | String | Si(1) | Identificador del documento cuyo enlace se quiere borrar. | folderId | String | Si | Identificador de la carpeta donde se borrará el enlace con el documento. |
NOTA : En caso de rellanar el id no habrá que rellenar el csv y viceversa.(1) Parámetros de respuesta Códigos de error Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#ResultDeleteDocumentLink Código | Nombre | Descripción |
|---|
180 | ERROR_FOLDERID_NULO | Debe especificar el Id de la carpeta. | 156 | ERROR_CSV_E_ID_NULOS | Debe especificar el id de Documentum o el CSV. | 131 | ERROR_GENERICO_PAPIRO | Se ha producido un error con PAPIRO. | 101 | ERROR_CONEXION_PAPIRO | Error de conexion con documentum. | 801 | GENERIC_ERROR | Error genérico procesando la petición. |
Ejemplo de invocación Invocación| Code Block |
|---|
ParamDeleteDocumentLink paramDeleteDocumentLink = new ParamDeleteDocumentLink();
paramDeleteDocumentLink.setCsv("CSV3G2ZOOM5NGAG1CCSV");
paramDeleteDocumentLink.setFolderId("09f54646511418");
ResultDeleteDocumentLink result = ccsvClient.deleteDocumentLink(paramDeleteDocumentLink);
if(result.getReturnCode().equals(ReturnCode.ERROR){
log.error(result.getErrorCode()+":"+result.getErrorMessage());
} |
|
Métodos de búsqueda.
Método 'search'
...
Realiza la búsqueda de documentos y expedientes en el gestor documental filtrando por los metadatos de los mismos.
...
| Expand |
|---|
|
Signatura ResultGetDocumentSignatures getDocumentSignatures(ParamGetDocumentSignatures paramGetDocumentSignatures). Parámetros de invocación Nombre | Tipo | Obligatorio | Descriprición |
|---|
ParamGetDocumentSignatures(hereda de CCSV_3.5.0_Manual de integración#ParamBase) | id | String | Si(1) | Codigo identificador de la firma en el repositorio documental. | csv | String | Si(1) | Código ccsv de la firma en el repositorio documental. |
NOTA : En caso de indicarse el CSV no se deberá indicar el id y viceversa.(1) Parámetros de respuesta Códigos de error Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#ResultGetDocumentSignatures. Código | Nombre | Descripción |
|---|
156 | ERROR_CSV_E_ID_NULOS | Debe especificar el identificador del documento o su CSV. | 127 | ERROR_CSV_NOEXISTE | No existe documento con el CSV especificado. | 191 | ERROR_INTEGRATIONAPPLICATION | Error al recuperar la información de la integración de aplicaciones. | 190 | ERROR_INTERNALACCESS_NOTALLOWED | No está permitido el acceso del nif solicitante al documento indicado. | 189 | ERROR_INTERNALACCESSCONTROL_NIFINVALID | Debe especificar el nif del solicitante del servicio | 192 | ERROR_CONEXION_PAU | Se ha producido un error al realizar la conexión con
PAU | 141 | ERROR_CONEXION_SIU | Se ha producido un error al realizar la conexión con SIU | 2019 | ERROR_FILE_TOO_LARGE | El documento es demasiado grande. Puede descargarlo llamando al servicio web de descarga de documentos de VAJE. | 131 | ERROR_GENERICO_PAPIRO | Se ha producido un error con PAPIRO. | 101 | ERROR_CONEXION_PAPIRO | Error de conexión con documentum. | 801 | GENERIC_ERROR | Error genérico procesando la petición. |
Ejemplo de invocación Invocación| Code Block |
|---|
ParamGetDocumentSignatures paramGetDocumentSignatures = new ParamGetDocumentSignatures();
paramGetDocumentSignatures.setId("0906fca3801922bb");
ResultGetDocumentSignatures result = ccsvClient.getDocumentSignatures(paramGetDocumentSignatures);
if(result.getReturnCode().equals(ReturnCode.OK){
ArrayList<Signature> signatures = result.getSignatures();
}else{
log.error(result.getErrorCode()+":"+result.getErrorMessage());
} |
|
Método 'initializeDocumentMetadata'
...
| Expand |
|---|
|
Signatura ResultDeleteMetadata deleteMetadata(ParamDeleteMetadata paramDeleteMetadata). Parámetros de invocación Nombre | Tipo | Obligatorio | Descriprición |
|---|
ParamUpdateMetadata(hereda de CCSV_3.5.0_Manual de integración#ParamBase) | id | String | Si(1) | Identificador del documento en Documentum. | csv | String | Si(1) | Código seguro de verificación del documento en Documentum. | metadataName | String | Si | Nombre del metadato que se quiere eliminar. | deleteAll | boolean | Si | Para metadatos repetitivos indica si se desean borrar todos los valores. | position | String | No | Indica la posicion del metadato repetitivo que queremos borrar. |
NOTA: En caso de indicar el id no se deberá indicar el csv y viceversa.(1) Parámetros de respuesta Códigos de error Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#ResultUpdateMetadata Código | Nombre | Descripción |
|---|
156 | ERROR_CSV_E_ID_NULOS | Se ha producido un error con PAPIRO. | 127 | ERROR_CSV_NOEXISTE | No existe documento con el CSV especificado. | 133 | ERROR_METADATONOEXISTE | No existe el metadato buscado para ese documento. | 134 | ERROR_POSICIONMETADATONOEXISTE | No existe metadato con ese orden o posición | 158 | ERROR_VERIFY_NOT_VALUELIST | El valor indicado no está entre los valores válidos para ese metadato. | 189 | ERROR_INTERNALACCESSCONTROL_NIFINVALID | Debe especificar el nif del solicitante del servicio | 190 | ERROR_INTERNALACCESS_NOTALLOWED | No está permitido el acceso del nif solicitante al documento indicado | 191 | ERROR_INTEGRATIONAPPLICATION | Error al recuperar la información de la integración de aplicaciones | 192 | ERROR_CONEXION_PAU | Se ha producido un error al realizar la conexión con PAU | 141 | ERROR_CONEXION_SIU | Se ha producido un error al realizar la conexión con SIU | 131 | ERROR_GENERICO_PAPIRO | Se ha producido un error con PAPIRO. | 101 | ERROR_CONEXION_PAPIRO | Error de conexión con documentum. | 801 | GENERIC_ERROR | Error genérico procesando la petición. |
Ejemplo de invocación Invocación| Code Block |
|---|
ParamDeleteMetadata paramDeleteMetadata = new ParamDeleteMetadata();
paramDeleteMetadata.setCsv("CSV3G2ZOOM5NGAG1CCSV");
paramDeleteMetadata.setMetadataName("dea_desc_descriptores");
paramDeleteMetadata.setDeleteAll(false);
paramDeleteMetadata.setPosition("1");
ResultDeleteMetadata result = ccsvClient.deleteMetadata(paramDeleteMetadata);
if(result.getReturnCode().equals(ReturnCode.ERROR){
log.error(result.getErrorCode()+":"+result.getErrorMessage());
} |
|
Métodos de gestión de relaciones.
Método 'createRelationship'
...
| Expand |
|---|
|
Signatura ResultGetAllRelatedDocuments getAllRelatedDocuments(ParamGetAllRelatedDocuments paramGetAllRelatedDocuments). Parámetros de invocación Nombre | Tipo | Obligatorio | Descriprición |
|---|
ParamGetAllRelatedDocuments(hereda de CCSV_3.5.0_Manual de integración#ParamBase) | id | String | Si(1) | Id del documento en Documentum cuyas relaciones queremos obtener. | csv | String | si(1) | CSV del documento cuyas relaciones queremos obtener. | role | String[] | No | Rol de las relaciones que queremos obtener. | dateStart | String | No | Fecha de inicio de la búsqueda que nos indicará si debemos incluir esa relación dentro de los resultados. | dateEnd | String | No | Fecha de fin de la búsqueda que nos indicará si debemos incluir esa relación dentro de los resultados. | addContent | boolean | Si | Indica si se añaden los contenidos de los documentos. | metadataNames | String[] | No | Nombres de los metadatos que queremos que nos muestre del el objeto Document de vuelta. | searchType | CCSV_3.5.0_Manual de integración#DocumentRelationSearchType | Si | Tipo de búsqueda a realizar: indica si queremos recuperar los documentos hijos relacionados o los documentos padre relacionados. |
NOTA : en caso de indicar el id del documento no habrá que indicar el csv y viceversa.(1) Parámetros de respuesta Códigos de error Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#ResultGetAllRelatedDocuments Código | Nombre | Descripción |
|---|
152 | ERROR_RELACION_ID_NULO | Faltan los parámetros para identificar el documento cuyas relaciones se desean buscar | 127 | ERROR_CSV_NOEXISTE | No existe documento con el CSV especificado | 131 | ERROR_GENERICO_PAPIRO | Se ha producido un error con PAPIRO | 153 | ERROR_RELACION_TIPOBUSQUEDA_NULO | Falta el parámetro que indica si se deben buscar los documentos hijos relacionados o los documentos padre relacionados | 148 | ERROR_DOCUMENTOS_RELACIONADOS | No se han encontrado documentos relacionados para el documento seleccionado. | 800 | ERROR_BASEDATOS_CSV | Error al conectar con la Base de Datos CSV | 191 | ERROR_INTEGRATIONAPPLICATION | Error al recuperar la información de la integración de aplicaciones. | 190 | ERROR_INTERNALACCESS_NOTALLOWED | No está permitido el acceso del nif solicitante al documento indicado | 189 | ERROR_INTERNALACCESSCONTROL_NIFINVALID | Debe especificar el nif del solicitante del servicio | 192 | ERROR_CONEXION_PAU | Se ha producido un error al realizar la conexión con PAU. | 141 | ERROR_CONEXION_SIU | Se ha producido un error al realizar la conexión con SIU | 101 | ERROR_CONEXION_PAPIRO | Error de conexión con documentum | 801 | GENERIC_ERROR | Error genérico procesando la petición. |
Ejemplo de invocación Invocación| Code Block |
|---|
ParamGetAllRelatedDocuments paramGetAllRelatedDocuments = new ParamGetAllRelatedDocuments();
paramGetAllRelatedDocuments.setCsv("CSV0B31WVP5O1A21CCSV");
paramGetAllRelatedDocuments.setSearchType(DocumentRelationSearchType.CHILD);
ResultGetAllRelatedDocuments result =ccsvClient.getAllRelatedDocuments(paramGetAllRelatedDocuments);
if(result.getReturnCode().equals(ReturnCode.OK){
DocumentTreeNode = result.getDocumentTreeNode();
}else{
log.error(result.getErrorCode()+”:”+result.getErrorMessage());
} |
|
Métodos de gestión de relaciones de agentes.
Método 'addAgentRelationship'
...
| Expand |
|---|
|
Signatura ResultGetDocumentSubtypeList getDocumentSubtypeList(ParamGetDocumentSubtypeList paramDocumentSubtypeList); Parámetros de invocación Parámetros de respuesta 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 CCSV_3.5.0_Manual de integración#updateMetadata ya que puede usarse independientemente del tipo de metadato que se intenta actualizar.
Servicio ISendAdminFileCloudWSPortType
El protocolo de Remisión en la Nube pretende ser un estándar para el intercambio de expedientes electrónicos en formato ENI (Esquema Nacional de Interoperabilidad) entre dos administraciones públicas cualesquiera, sean estas administrativas o judiciales.
...