...
Servicio AdministrativeFileService
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 ResultGetAdministrativeFile getAdministrativeFile(ParamGetAdministrativeFile paramGetAdministrativeFile). Parámetros de invocación Nombre | Tipo | Obligatorio | Descripción |
---|
ParamGetAdministrativeFile (hereda de ParamBase) | csv | String | Si(1) | CSV del expediente a consultar. | id | String | Si(1) | OID del expediente a consultar. | metadata | String[] | No(por defecto añade todos) | Array de los metadatos que se quieren recuperar. | includeIndexContent | boolean | Si | Indica si se desea recuperar el índice actual del expediente. | includeContent | boolean | Si | Indica si se desean recuperar los contenidos de los documentos del expediente. | attachIndexSignature | boolean | Si | Indica si se desea recuperar la firma asociada al índice. |
NOTA: Si se consulta por csv no se rellena el campo id y viceversa.(1) Parámetros de respuesta Nombre | Tipo | Descripción |
---|
Anchor |
---|
| ResultGetAdministrativeFile |
---|
| ResultGetAdministrativeFile |
---|
| ResultGetAdministrativeFile (hereda de ResultError) | adminFile | AdministrativeFile | Documento con el índice y metadatos del expediente. | adminFileContents | AdministrativeFileRelation[] | Contenidos del expediente. | signatures | ArrayList<Signature> | Firmas asociadas al índice del expediente. |
Códigos de error Los errores de la invocación se encapsulan en ResultGetAdministrativeFile Código | Nombre | Descripción |
---|
1017 | ERROR_ADMINFILE_CSV_E_ID_NULOS | No se ha especificado el id o el CSV del expediente. | 1002 | ERROR_DOCUMENTMETADATA | Error del DocumentMetadataManager. | 801 | GENERIC_ERROR | Error genérico procesando la petición. |
Ejemplo de invocación Invocación Code Block |
---|
| ParamGetAdministrativeFile paramGetAdministrativeFile = new
ParamGetAdministrativeFile();
paramGetAdministrativeFile.setId("0906fca3801922bb");
paramGetAdministrativeFile.setIncludeContent(false);
paramGetAdministrativeFile.setAttachIndexSignature(false);
ResultGetAdministrativeFile result =ccsvClient.getAdministrativeFile(paramGetAdministrativeFile);
if(result.getReturnCode().equals(ReturnCode.OK){
AdministrativeFile adminFile =result.getAdminFile();
AdministrativeFileRelation[] adminFileContents=result.getAdminFileContents();
ArrayList<Signature> signatures=result.getSignatures();
}else{
log.error(result.getErrorCode()+":"+result.getErrorMessage());
} |
|
Método '
...
getAdminFileLiteAdv'
...
Recupera el conjunto de datos mínimo pero suficiente para la consulta de expedientes. Permite indicar filtrar los datos a devolver; si se desean recuperar todos los agentes del expediente, si se desean recuperar los documentos del expediente, si se desean recuperar las carpetas del expediente y si se desean recuperar los subexpedientes del expediente.
Expand |
---|
|
Signatura ResultGetAdministrativeFileLite getAdminFileLiteResultGetAdministrativeFileLiteAdv getAdminFileLiteAdv(ParamGetAdministrativeFileLite paramGetAdministrativeFileLite); Parámetros de invocación Nombre | Tipo | Obligatorio | Descripción |
---|
ParamGetAdministrativeFileLite (hereda de ParamBase) | csv | String | Si(1) | CSV del expediente a consultar. | id | String | Si(1) | OID del expediente a consultar. | addAgents | boolean | Si | Indica si se desean recuperar los agentes del expediente. | addDocuments | boolean | Si | Indica si se desean recuperar los documentos del expediente. | addFolders | boolean | Si | Indica si se desean recuperar las carpetas del expediente. | addSubAdminFiles | boolean | Si | Indica si se desean recuperar los subexpedientes del expediente. |
NOTA: Si se consulta por csv no se rellena el campo id y viceversa.(1) Parámetros de respuesta Nombre | Tipo | Descripción |
---|
Anchor |
---|
| ResultGetAdministrativeFile |
---|
| ResultGetAdministrativeFile |
---|
|
| ResultGetAdministrativeFileLite ResultGetAdministrativeFileLiteAdv (hereda de ResultError) | administrativeFileLite | AdministrativeFileLite | Metadatos básicos del expediente. | administrativeFileDocumentLiteListadministrativeFileDocumentAdvLiteList | Vector<AdministrativeFileDocumentLite>Vector<AdministrativeFileDocumentLiteAdv> | Listado de documentos del expediente incluye el nombre y procedimiento del documento. | administrativeFileFolderLiteList | Vector<AdministrativeFileFolderLite> | Listado de carpetas del expediente. | administrativeFileAgentLiteList | Vector<AdministrativeFileAgentLite> | Listado de agentes del expediente. | administrativeFileLiteList | Vector<AdministrativeFileLite> | Listado de subexpedientes del expediente. |
Códigos de error Los errores de la invocación se encapsulan en ResultGetAdministrativeFileResultGetAdministrativeFileLiteAdv Código | Nombre | Descripción |
---|
1017 | ERROR_ADMINFILE_CSV_E_ID_NULOS | No se ha especificado el id o el CSV del expediente. | 1002 | ERROR_DOCUMENTMETADATA | Error del DocumentMetadataManager. | 801 | GENERIC_ERROR | Error genérico procesando la petición. |
Ejemplo de invocación Invocación Code Block |
---|
| ParamGetAdministrativeFileLite paramGetAdministrativeFileLite = new ParamGetAdministrativeFileLite();
paramGetAdministrativeFileLite.setApplicationId("appCode");
paramGetAdministrativeFileLite.setNif("userNif");
paramGetAdministrativeFileLite.setCsv("CCSVXXXXXXXXXXCSV");
paramGetAdministrativeFileLite.setAddAgents(true);
paramGetAdministrativeFileLite.setAddDocuments(true);
paramGetAdministrativeFileLite.setAddFolders(true);
paramGetAdministrativeFileLite.setAddSubAdminFiles(true);
ResultGetAdministrativeFileLiteResultGetAdministrativeFileLiteAdv resultGetAdministrativeFileLiteresultGetAdministrativeFileLiteAdv = ccsvClient.getAdminFileLitegetAdminFileLiteAdv(paramGetAdministrativeFileLite); |
|
Método '
...
getDocumentXml'
...
Similar al método getAdminFileLite pero también recupera el nombre y numero de procedimiento de los documentos.Recupera el documento xml del expediente codificado en Base64
Expand |
---|
|
Signatura ResultGetAdministrativeFileLiteAdv getAdminFileLite(ParamGetAdministrativeFileLite paramGetAdministrativeFileLite);ResultGetDocumentXml getDocumentXml(ParamGetDocumentXml paramGetDocumentXml). Parámetros de invocación Nombre | Tipo | Obligatorio | Descripción |
---|
ParamGetAdministrativeFileLite ParamGetDocumentXml(hereda de ParamBase) | csv | String | Si(1) | CSV del expediente a consultar. | id | String | Si(1) | OID del expediente a consultar. |
addAgents | boolean | Si | Indica si se desean recuperar los agentes del expediente. | addDocuments | boolean | Si | Indica si se desean recuperar los documentos del expediente. | addFolders | boolean | Si | Indica si se desean recuperar las carpetas del expediente. | addSubAdminFiles | boolean | Si | Indica si se desean recuperar los subexpedientes del expediente. | NOTA: Si se consulta por csv no se rellena el campo id y NOTA: Si se consulta por csv no se rellena el campo id y viceversa.(1) Parámetros de respuesta ResultGetAdministrativeFileResultGetAdministrativeFileResultGetAdministrativeFileLiteAdv administrativeFileLiteadministrativeFileDocumentAdvLiteList | Vector<AdministrativeFileDocumentLiteAdv> | Listado de documentos del expediente incluye el nombre y procedimiento del documento. | administrativeFileFolderLiteList | Vector<AdministrativeFileFolderLite> | Listado de carpetas del expediente. | administrativeFileAgentLiteList | Vector<AdministrativeFileAgentLite> | Listado de agentes del expediente. | administrativeFileLiteList | Vector<AdministrativeFileLite> | Listado de subexpedientes del expediente. | AdministrativeFileLite | Metadatos básicos del expediente. | String | Documento en xml de la respuesta codificado en base64. | id | String | Id del documento de la respuesta. |
Códigos de error Los errores de la invocación se encapsulan en ResultGetAdministrativeFileen ResultGetDocumentXml 1017ADMINFILE_CSV_E_ID_NULOSDOCUMENTOS_RELACIONADOS | No se | ha especificado el id o el CSV del expediente.1002 | ERROR_DOCUMENTMETADATA | Error del DocumentMetadataManager. | 801 | GENERIC_ERROR | Error genérico procesando la petición. | Ejemplo de invocación Invocaciónhan encontrado documentos relacionados para el documento seleccionado | 1042 | ERROR_XML_ADMINFILE_EMPTY | El expediente debe tener contenido | 1206 | THREAD_ERROR | Hubo un error al generar uno o más de los documentos Eni | 193 | ERROR_BASEDATOS_CCSV | Error al conectar con la Base de Datos CSV | 801 | GENERIC_ERROR | Error genérico procesando la petición. |
Ejemplo de invocación Invocación Code Block |
---|
| ParamGetAdministrativeFileLiteParamGetDocumentXml paramGetAdministrativeFileLiteparamGetDocumentXml = new ParamGetAdministrativeFileLiteParamGetDocumentXml();
paramGetAdministrativeFileLiteParamGetDocumentXml.setApplicationIdsetCsv("appCodeCCSV54641878471CCSV");
paramGetAdministrativeFileLite.setNif("userNif"ResultGetDocumentXml result =ccsvClient.getDocumentXml (paramGetDocumentXml);
paramGetAdministrativeFileLiteif(result.setCsvgetReturnCode("CCSVXXXXXXXXXXCSV");
paramGetAdministrativeFileLite.setAddAgentsequals(trueReturnCode.ERROR);{
paramGetAdministrativeFileLite log.setAddDocuments(true);
paramGetAdministrativeFileLite.setAddFolders(true);
paramGetAdministrativeFileLite.setAddSubAdminFiles(true);
ResultGetAdministrativeFileLite resultGetAdministrativeFileLite = ccsvClient.getAdminFileLite(paramGetAdministrativeFileLite); |
|
Método 'getDocumentXml'
...
error(result.getErrorCode()+":"+result.getErrorMessage());
} |
|
Método 'initializeAdministrativeFileMetadata'
...
Inicializa los metadatos del expediente electrónico en función de los parámetros aportados y, opcionalmente, de un documento ya existente en el gestor documental
Expand |
---|
|
Signatura ResultGetDocumentXml getDocumentXml(ParamGetDocumentXml paramGetDocumentXmlResultInitializeAdministrativeFileMetadata initializeAdministrativeFileMetadata(ParamInitializeAdministrativeFileMetadata paramInitializeAdministrativeFileMetadata). Parámetros de invocación Nombre | Tipo | Obligatorio | Descripción |
---|
ParamGetDocumentXmlParamInitializeAdministrativeFileMetadata(hereda de ParamBase) | csvapplicationCode | String | Si | Código de aplicación que da de alta el expediente | applicationName | String | Si | Nombre de aplicación que da de alta el expediente | type | String | Si | (1)CSV a consultar.id(1)OID a consultar. NOTA: Si se consulta por csv no se rellena el campo id | name | String | Si | Nombre del expediente | description | String | Si | Descripción del expediente | date | Date | Si | Fecha de apertura del expediente | procedureCode | String | No | Código de procedimiento asociado al expediente | adminFileContentCsv | String | No(1) | CSV del documento contenido en el expediente si ya existe | adminFileContentId | String | No(1) | Id del documento contenido en el expediente si ya existe |
NOTA: En caso de indicar el adminFileContentCsv no habrá que indicar el adminFileContentId y viceversa.(1)
Parámetros de respuesta ResultGetDocumentXml | ResultInitializeAdministrativeFileMetadata |
---|
|
| ResultGetDocumentXml | ResultInitializeAdministrativeFileMetadata |
---|
|
| ResultGetDocumentXmlResultInitializeAdministrativeFileMetadata(hereda de ResultError)
| base64XmlString | Documento en xml de la respuesta codificado en base64. | id | String | Id del documento de la respuesta. Códigos de error Los errores de la invocación se encapsulan en ResultGetDocumentXml ResultInitializeAdministrativeFileMetadata 148DOCUMENTOSRELACIONADOSNo se han encontrado documentos relacionados para el documento seleccionado | 1042NAMENULO | Debe especificar el parámetro name con el nombre del expediente | 1006 | ERROR_ | XML_EMPTYEl expediente debe tener contenido | 1206 | THREAD_ERROR | Hubo un error al generar uno o más de los documentos Eni | 193 | ERROR_BASEDATOS_CCSV | Error al conectar con la Base de Datos CSVDESCRIPTIONNULO | Debe especificar el parámetro description con la descripción del expediente | 1009 | ERROR_ADMINFILE_APPLICODENULO | Debe especificar el código de aplicación | 1010 | ERROR_ADMINFILE_APPLINAMENULO | Debe especificar el nombre de aplicación | 1011 | ERROR_ADMINFILE_NUMBERNULO | Debe especificar el número del expediente | 1012 | ERROR_ADMINFILE_TYPERNULO | Debe especificar el tipo del expediente | 1022 | ERROR_ADMINFILE_DATENULO | Debe especificar la fecha de apertura del expediente | 1002 | ERROR_DOCUMENTMETADATA | Error del DocumentMetadataManager | 801 | GENERIC_ERROR | Error genérico procesando la petición. |
Ejemplo de invocación Invocación Code Block |
---|
| ParamGetDocumentXmlParamInitializeAdministrativeFileMetadata paramGetDocumentXmlparamInitializeAdministrativeFileMetadata = new ParamInitializeAdministrativeFileMetadata ParamGetDocumentXml();
ParamGetDocumentXmlparamInitializeAdministrativeFileMetadata .setCsvsetApplicationCode("CCSV54641878471CCSVCodigoAplicación");
ResultGetDocumentXmlparamInitializeAdministrativeFileMetadata result =ccsvClient.getDocumentXml (paramGetDocumentXml);
if(result..setApplicationId("IdAplicacion");
paramInitializeAdministrativeFileMetadata .setApplicationName("NombreAplicación");
paramInitializeAdministrativeFileMetadata .setType("tipoExpediente");
paramInitializeAdministrativeFileMetadata .setNumber("numeroExpediente");
paramInitializeAdministrativeFileMetadata .setName("nombreExpediente");
paramInitializeAdministrativeFileMetadata .setDescription("descripción");
paramInitializeAdministrativeFileMetadata .setDate(new Date());
ResultInitializeAdministrativeFileMetadata result = ccsvClient.initializeAdminFileMetadata(paramInitializeAdminFileMetadata);
if(result.getReturnCode().equals(ReturnCode.ERROR).OK){
AdministrativeFile administrativeFile =result.getAdministrativeFile();
}else{
log.error(result.getErrorCode()+":"+result.getErrorMessage());
} |
|
Método 'initializeAdministrativeFileMetadata'
Inicializa los metadatos del expediente electrónico en función de los parámetros aportados y, opcionalmente, de un documento ya existente en el gestor documental
Expand |
---|
|
Signatura ResultInitializeAdministrativeFileMetadata initializeAdministrativeFileMetadata(ParamInitializeAdministrativeFileMetadata paramInitializeAdministrativeFileMetadata). Parámetros de invocación |
Nombre | Tipo | Obligatorio | Descripción |
---|
ParamInitializeAdministrativeFileMetadata(hereda de ParamBase) |
applicationCode | String | Si | Código de aplicación que da de alta el expediente |
applicationName | String | Si | Nombre de aplicación que da de alta el expediente |
type | String | Si | Tipo del expediente |
number | String | Si | Número del expediente |
name | String | Si | Nombre del expediente |
description | String | Si | Descripción del expediente |
date | Date | Si | Fecha de apertura del expediente |
procedureCode | String | No | Código de procedimiento asociado al expediente |
adminFileContentCsv | String | No(1) | CSV del documento contenido en el expediente si ya existe |
adminFileContentId | String | No(1) | Id del documento contenido en el expediente si ya existe |
NOTA: En caso de indicar el adminFileContentCsv no habrá que indicar el adminFileContentId y viceversa.(1)
Parámetros de respuesta
Nombre | Tipo | Descripción |
---|
Anchor |
---|
ResultInitializeAdministrativeFileMetadata | ResultInitializeAdministrativeFileMetadata | ResultInitializeAdministrativeFileMetadata(hereda de ResultError)
adminFile | AdministrativeFile | Documento con el índice y metadatos del expediente |
adminFileContents | AdministrativeFileRelation[] | Contenidos del expediente |
signatures | ArrayList<Signature> | Firmas asociadas al índice del expediente |
Códigos de error
Los errores de la invocación se encapsulan en ResultInitializeAdministrativeFileMetadata
Código | Nombre | Descripción |
---|
1005 | ERROR_ADMINFILE_NAMENULO | Debe especificar el parámetro name con el nombre del expediente |
1006 | ERROR_ADMINFILE_DESCRIPTIONNULO | Debe especificar el parámetro description con la descripción del expediente |
1009 | ERROR_ADMINFILE_APPLICODENULO | Debe especificar el código de aplicación |
1010 | ERROR_ADMINFILE_APPLINAMENULO | Debe especificar el nombre de aplicación |
1011 | ERROR_ADMINFILE_NUMBERNULO | Debe especificar el número del expediente |
1012 | ERROR_ADMINFILE_TYPERNULO | Debe especificar el tipo del expediente |
1022 | ERROR_ADMINFILE_DATENULO | Debe especificar la fecha de apertura del expediente |
1002 | ERROR_DOCUMENTMETADATA | Error del DocumentMetadataManager |
801 | GENERIC_ERROR | Error genérico procesando la petición. |
Ejemplo de invocación
Invocación
Code Block |
---|
|
ParamInitializeAdministrativeFileMetadata paramInitializeAdministrativeFileMetadata = new ParamInitializeAdministrativeFileMetadata ();
paramInitializeAdministrativeFileMetadata .setApplicationCode("CodigoAplicación");
paramInitializeAdministrativeFileMetadata .setApplicationId("IdAplicacion");
paramInitializeAdministrativeFileMetadata .setApplicationName("NombreAplicación");
paramInitializeAdministrativeFileMetadata .setType("tipoExpediente");
paramInitializeAdministrativeFileMetadata .setNumber("numeroExpediente");
paramInitializeAdministrativeFileMetadata .setName("nombreExpediente");
paramInitializeAdministrativeFileMetadata .setDescription("descripción");
paramInitializeAdministrativeFileMetadata .setDate(new Date());
ResultInitializeAdministrativeFileMetadata result = ccsvClient.initializeAdminFileMetadata(paramInitializeAdminFileMetadata);
if(result.getReturnCode().equals(ReturnCode.OK){
AdministrativeFile administrativeFile =result.getAdministrativeFile();
}else{
log.error(result.getErrorCode()+":"+result.getErrorMessage());
}
/**
* Faltarían metadatos obligatorios, esto es solo un ejemplo de uso.
*/
ParamVerifyDocumentMetadata paramVerifyDocumentMetadata = new ParamVerifyDocumentMetadata();
paramVerifyDocumentMetadata.setDocument(administrativeFile);
paramVerifyDocumentMetadata.setDocumentType("EXPEDIENTE");
/**
* Faltarían metadatos obligatorios, esto es solo un ejemplo de uso.
*/
ParamVerifyDocumentMetadata paramVerifyDocumentMetadata = new ParamVerifyDocumentMetadata();
paramVerifyDocumentMetadata.setDocument(administrativeFile);
paramVerifyDocumentMetadata.setDocumentType("EXPEDIENTE");
ResultVerifyDocumentMetadata result2 = ccsvClient.verifyDocumentMetadata (paramVerifyDocumentMetadata);
if(result2.getReturnCode().equals(ReturnCode.ERROR){
for (int i=0;i<result2.getMetadataValueVerificationList().size();i++){
System.out.println(result2.getMetadataValueVerificationList().get(i));
}
}
|
...
Expand |
---|
|
Signatura ResultOpenAdministrativeFile openAdministrativeFile(ParamOpenAdministrativeFile paramOpenAdministrativeFile) Parámetros de invocación Nombre | Tipo | Obligatorio | Descripción |
---|
ParamOpenAdministrativeFile(hereda de ParamBase) | adminFile | AdministrativeFile | Si | Documento con el índice y metadatos del expediente | folderId | String | No | Identificador de la carpeta de Documentum | aclName | String | No | Nombre de la lista de control de accesos al fichero | signedDocument | SignedDocument | (1) | Documento contenido en el expediente | adminFileContentCsv | String | (2) | CSV del documento contenido en el expediente si ya existe | adminFileContentId | String | (2) | Id del documento contenido en el expediente si ya existe | createAdminFileContent | boolean | Si | Indica si el documento contenido en el expediente existe o hay que crearlo |
NOTA : si createAdminFileContent es true signedDocument será obligatorio (1) ,en caso de ser falso habrá que indicar o el Csv o el id en documentum(2) Parámetros de respuesta Nombre | Tipo | Descripción |
---|
Anchor |
---|
| ResultOpenAdministrativeFile |
---|
| ResultOpenAdministrativeFile |
---|
| ResultOpenAdministrativeFile(hereda de ResultError)
| id | String | Identificador en Documentum del expediente creado. | adminFileContentId | String | Identificador en Documentum del documento contenido creado. |
Códigos de error Los errores de la invocación se encapsulan en ResultOpenAdministrativeFile Código | Nombre | Descripción |
---|
1021 | ERROR_ADMINFILENULO | Debe especificar el adminFile con todos los datos del expediente. | 1003 | ERROR_ADMINFILE_CSVNULO | Debe especificar el valor del CSV del expediente | 1005 | ERROR_ADMINFILE_NAMENULO | Debe especificar el parámetro name con el nombre del expediente | 1007 | ERROR_ADMINFILE_CSV_E_ID_DOC_CONTENIDO_NULOS | Debe especificar el id o el CSV del documento contenido del expediente | 1008 | ERROR_ADMINFILE_DOC_CONTENIDO_NULO | Debe especificar un documento contenido y su firma | 1009 | ERROR_ADMINFILE_APPLICODENULO | Debe especificar el código de aplicación | 1010 | ERROR_ADMINFILE_APPLINAMENULO | Debe especificar el nombre de aplicación | 1011 | ERROR_ADMINFILE_NUMBERNULO | Debe especificar el número del expediente | 1012 | ERROR_ADMINFILE_TYPERNULO | Debe especificar el tipo del expediente | 1019 | ERROR_ADMINFILE_OPENORIGINALCOPIA | No se puede abrir un expediente con un documento que no esté en estado Original o Copia | 1002 | ERROR_DOCUMENTMETADATA | Error del DocumentMetadataManager | 801 | GENERIC_ERROR | Error genérico procesando la petición. |
Ejemplo de invocación Invocación Code Block |
---|
| ParamOpenAdministrativeFile paramOpenAdministrativeFile = new ParamOpenAdministrativeFile();
//adminFile es un AdministrativeFile inicializado y ya con todos los datos.
paramOpenAdministrativeFile.setAdminFile(adminFile);
paramOpenAdministrativeFile.setCreateAdminFileContent(false);
paramOpenAdministrativeFile.setAdminFileContentCsv("CSV25754872574CCSV");
ResultOpenAdministrativeFile result =ccsvClient.openAdministrativeFile(paramOpenAdministrativeFile);
if(result.getReturnCode().equals(ReturnCode.OK){
String id =result.getId();
String adminFileContentId =result.getAdminFileContentId();
}else{
log.error(result.getErrorCode()+":"+result.getErrorMessage());
} |
|
...
Expand |
---|
|
Signatura ResultCloseAdministrativeFile closeAdministrativeFile(ParamCloseAdministrativeFile paramCloseAdministrativeFile) Parámetros de invocación Nombre | Tipo | Obligatorio | Descripción |
---|
ParamCloseAdministrativeFile (hereda de ParamBase) | csv | String | Si(1) | CSV del expediente del expediente a cerrar. | id | String | Si(1) | Identificador del expediente a cerrar. | date | Date | No | Fecha de cierre del expediente. |
NOTA: Si se consulta por csv no se rellena el campo id y viceversa.(1) Parámetros de respuesta Nombre | Tipo | Descripción |
---|
Anchor |
---|
| ResultCloseAdministrativeFile |
---|
| ResultCloseAdministrativeFile |
---|
| ResultCloseAdministrativeFile(hereda de ResultError)
|
Códigos de error Los errores de la invocación se encapsulan en ResultCloseAdministrativeFile Código | Nombre | Descripción |
---|
1017 | ERROR_ADMINFILE_CSV_E_ID_NULOS | Debe especificar el id o el CSV del expediente | 1002 | ERROR_DOCUMENTMETADATA | Error del DocumentMetadataManager | 801 | GENERIC_ERROR | Error genérico procesando la petición. |
Ejemplo de invocación Invocación Code Block |
---|
| ParamCloseAdministrativeFile paramCloseAdministrativeFile = new ParamCloseAdministrativeFile();
paramCloseAdministrativeFile.setCsv("CSV6587268741454CCSV");
ResultCloseAdministrativeFile result = ccsvClient.closeAdministrativeFile(paramCloseAdministrativeFile);
if(result.getReturnCode().equals(ReturnCode.ERROR){
log.error(result.getErrorCode()+":"+result.getErrorMessage());
} |
|
...
Expand |
---|
|
Signatura ResultReopenAdministrativeFile reopenAdministrativeFile(ParamReopenAdministrativeFile paramReopenAdministrativeFile); Parámetros de invocación Nombre | Tipo | Obligatorio | Descripción |
---|
ParamReopenAdministrativeFile(hereda de ParamBase) | csv | String | Si(1) | CSV del expediente del expediente a reabrir. | id | String | Si(1) | Identificador del expediente a reabrir. | date | Date | No | Fecha de reapertura del expediente. |
NOTA: Si se consulta por csv no se rellena el campo id y viceversa. Parámetros de respuesta Nombre | Tipo | Descripción |
---|
Anchor |
---|
| ResultReopenAdministrativeFile |
---|
| ResultReopenAdministrativeFile |
---|
| ResultReopenAdministrativeFile(hereda de ResultError)
|
Códigos de error Los errores de la invocación se encapsulan en ResultReopenAdministrativeFile Código | Nombre | Descripción |
---|
1017 | ERROR_ADMINFILE_CSV_E_ID_NULOS | Debe especificar el id o el CSV del expediente | 104 | ERROR_REEMPLAZAR_PAPIRO | [PAPIRO] Error al intentar reemplazar el documento. | 1002 | ERROR_DOCUMENTMETADATA | Error del DocumentMetadataManager | 801 | GENERIC_ERROR | Error genérico procesando la petición. |
Ejemplo de invocación Invocación Code Block |
---|
| ParamReopenAdministrativeFile paramReopenAdministrativeFile = new ParamReopenAdministrativeFile();
paramReopenAdministrativeFile.setCsv("CCSV54641878471CCSV");
paramReopenAdministrativeFile.setDate(new Date());
ResultReopenAdministrativeFile result = ccsvClient.reopenAdministrativeFile(paramReopenAdministrativeFile);
if(result.getReturnCode().equals(ReturnCode.ERROR){
log.error(result.getErrorCode()+":"+result.getErrorMessage());
} |
|
Método 'changeAdministrativeFileState'
Permite cambiar el estado del expediente actuando sobre el metadato expediente_estado. Los cambios posibles serán:
De Abierto a Cerrado
De Abierto a Índice para Remisión Cerrado.
);
paramReopenAdministrativeFile.setDate(new Date());
ResultReopenAdministrativeFile result = ccsvClient.reopenAdministrativeFile(paramReopenAdministrativeFile);
if(result.getReturnCode().equals(ReturnCode.ERROR){
log.error(result.getErrorCode()+":"+result.getErrorMessage());
} |
|
Método 'changeAdministrativeFileState'
...
Permite cambiar el estado del expediente actuando sobre el metadato expediente_estado. Los cambios posibles serán:
De Abierto a Cerrado
De Abierto a Índice para Remisión Cerrado.
NOTA: Se puede cambiar el estado de un expediente de abierto a cerrado. También se puede pasar al estado Índice para Remisión Cerrado. ¿Qué implica este cambio de pasar a Índice para Remisión Cerrado en el expediente?
Este estado fue definido en la resolución del BOE https://www.boe.es/buscar/doc.php?id=BOE-A-2011-13170 como una de los posibles opciones en el esquema de valores para el estado de un expediente en el momento del intercambio y su definición seria “Estado cuando se intercambia un expediente y en ese momento se cierra el índice para garantizar que los documentos que se mandan asociados a dicho expediente son los de ese índice en concreto”. Actualmente no se esta haciendo uso de este estado.
Expand |
---|
|
Signatura ResultChangeAdministrativeFileState changeAdministrativeFileState(ParamChangeAdministrativeFileState paramChangeAdministrativeFileState); Parámetros de invocación Nombre | Tipo | Obligatorio | Descripción |
---|
ParamChangeAdministrativeFileState(hereda de ParamBase) | csv | String | Si(1) | CSV del expediente a cambiar de estado. | id | String | Si(1) | Identificador del expediente a cambiar de estado. | state | String | Si | Nuevo estado del expediente. |
NOTA: Si se consulta por csv no se rellena el campo id y viceversa.(1) Parámetros de respuesta Nombre | Tipo | Descripción |
---|
Anchor |
---|
| ResultChangeAdministrativeFileState |
---|
| ResultChangeAdministrativeFileState |
---|
| ResultChangeAdministrativeFileState(hereda de ResultError)
|
Códigos de error Los errores de la invocación se encapsulan en ResultChangeAdministrativeFileState Código | Nombre | Descripción |
---|
1017 | ERROR_ADMINFILE_CSV_E_ID_NULOS | Debe especificar el id o el CSV del expediente | 1013 | ERROR_ADMINFILE_STATENULO | Debe especificar el estado del expediente | 1024 | ERROR_ADMINFILE_CHANGESTATE | El expediente sólo se puede cambiar a estado Cerrado o a Índice para Remisión Cerrado | 1023 | ERROR_ADMINFILE_CHANGESTATE_NOTOPEN | No se puede cambiar el estado si el expediente no está abierto | 1002 | ERROR_DOCUMENTMETADATA | Error del DocumentMetadataManager | 801 | GENERIC_ERROR | Error genérico procesando la petición. |
Ejemplo de invocación Invocación Code Block |
---|
| ParamChangeAdministrativeFileState paramChangeAdministrativeFileState = new ParamChangeAdministrativeFileState();
paramChangeAdministrativeFileState.setCsv("CSV854546458461CCSV");
paramChangeAdministrativeFileState.setState(DocumentumConstants.EstadoExpediente.INDICE_REMISION_CERRADO);
ResultChangeAdministrativeFileState result = ccsvClient.changeAdministrativeFileState(paramChangeAdministrativeFileState);
if(result.getReturnCode().equals(ReturnCode.ERROR){
log.error(result.getErrorCode()+":"+result.getErrorMessage());
} |
|
...
Permite anular un expediente. Este método está deprecado. En su lugar hay que usar el annulateAdminFileWithReason.
Expand |
---|
|
Signatura ResultAnnulateAdminFile annulateAdminFile(ParamAnnulateAdminFile param); Parámetros de invocación Nombre | Tipo | Obligatorio | Descripción |
---|
ParamAnnulateAdminFile (hereda de ParamBase) | csv | String | Si | CSV del expediente a anular. |
Parámetros de respuesta Nombre | Tipo | Descripción |
---|
ResultAnnulateAdminFile (hereda de ResultError) |
Códigos de error Código | Nombre | Descripción |
---|
127 | ERROR_CSV_NOEXISTE | No existe documento con el CSV especificado | 1044 | ERROR_IS_NOT_ADMINFILE | El documento no es un expediente administrativo. | 1045 | ERROR_ADMINFILE_CLOSED | El expediente administrativo no se encuentra abierto. | 1046 | ERROR_ADMINFILE_ANNULATED | El expediente administrativo se encuentra ANULADO y no puede ser modificado. | 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 |
---|
| ParamAnnulateAdminFile paramAnnulateAdminFile = new ParamAnnulateAdminFile();
paramAnnulateAdminFile.setApplicationId("appCode");
paramAnnulateAdminFile.setAdminFileCsv("CCSVXXXXXXXXXXCSV");
ResultAnnulateAdminFile resultAnnulateAdminFile = ccsvClient.annulateAdminFile(paramAnnulateAdminFile);
|
|
Métodos para la gestión de índices de expedientes.
Método '
...
annulateAdminFileWithReason'
...
Recupera el índice del expedientePermite anular un expediente añadiendo un motivo.
Expand |
---|
|
Signatura ResultGetAdministrativeFileIndex getAdministrativeFileIndex(ParamGetAdministrativeFileIndex paramGetAdministrativeFileIndexResultAnnulateAdminFileWithReason annulateAdminFileWithReason(ParamAnnulateAdminFileWithReason param); Parámetros de invocación Nombre | Tipo | Obligatorio | Descripción |
---|
ParamGetAdministrativeFileIndex ParamAnnulateAdminFileWithReason (hereda de | ParamBasecsv(1) del índice consultaridSi(1) | Identificador del índice No | Motivo de la anulacion del expediente | a consultarNOTA: Si se consulta por csv no se rellena el campo id y viceversa.(1) Parámetros de respuesta Anchor |
---|
ResultGetAdministrativeFileIndex | ResultGetAdministrativeFileIndex | ResultGetAdministrativeFileIndex(hereda de ResultError)content | DataHandler | Contenido del índice electrónico del expediente electrónico administrativo | Códigos de error Los errores de la invocación se encapsulan en ResultGetAdministrativeFileIndex Código | Nombre | Descripción |
---|
1017 | ERROR_ADMINFILE_CSV_E_ID_NULOS | Debe especificar el id o el CSV del expediente | 1034Códigos de error Código | Nombre | Descripción |
---|
127 | ERROR_CSV_NOEXISTE | No existe documento con el CSV especificado | 1044 | ERROR_IS_NOT_ADMINFILE | El documento no es un expediente administrativo. | 1045 | ERROR_ADMINFILE_CLOSED | El expediente administrativo no se encuentra abierto. | 1046 | ERROR_ADMINFILE_ | STATENULO índice del expediente solicitado está pendiente de regenerarse1002expediente administrativo se encuentra ANULADO y no puede ser modificado. | 130 | ERROR_ | DOCUMENTMETADATA del DocumentMetadataManageral 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 |
---|
| ParamGetAdministrativeFileIndex paramGetAdministrativeFileIndexParamAnnulateAdminFileWithReason paramAnnulateAdminFileWithReason = new ParamGetAdministrativeFileIndexParamAnnulateAdminFileWithReason();
paramGetAdministrativeFileIndex.setId("0906fca3801922bb");
ResultGetAdministrativeFileIndex result = ccsvClient.getAdministrativeFileIndex(paramGetAdministrativeFileIndexparamAnnulateAdminFileWithReason.setApplicationId("appCode");
if(resultparamAnnulateAdminFileWithReason.getReturnCodesetAdminFileCsv("CCSVXXXXXXXXXXCSV");
paramAnnulateAdminFileWithReason.equals(ReturnCode.OK){
DataHandler content = result.getContent();
}else{
log.error(result.getErrorCode()+":"+result.getErrorMessage());
} |
|
Método 'regenerateAdministrativeFileIndex'
...
setReason("Motivo de la anulación");
ResultAnnulateAdminFileWithReason resultAnnulateAdminFileWithReason = ccsvClient.annulateAdminFileWithReason(paramAnnulateAdminFileWithReason); |
|
Métodos para la gestión de índices de expedientes.
Método 'getAdministrativeFileIndex'
...
Recupera el índice del expediente
Expand |
---|
|
Signatura ResultRegenerateAdministrativeFileIndex regenerateAdministrativeFileIndex(ParamRegenerateAdministrativeFileIndex paramRegenerateAdministrativeFileIndexResultGetAdministrativeFileIndex getAdministrativeFileIndex(ParamGetAdministrativeFileIndex paramGetAdministrativeFileIndex); Parámetros de invocación Nombre | Tipo | Obligatorio | Descripción |
---|
ParamRegenerateAdministrativeFileIndex ParamGetAdministrativeFileIndex (hereda de ParamBase) | csv | String | Si(1) | CSV del | expediente del que se va a regenerar el índicea consultar. | id | String | Si(1) | Identificador del índice del expediente | del que se va a regenerar el índice.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.(2el campo id y viceversa.(1) Parámetros de respuesta ResultRegenerateAdministrativeFileIndex | ResultGetAdministrativeFileIndex |
---|
|
| ResultRegenerateAdministrativeFileIndex | ResultGetAdministrativeFileIndex |
---|
|
| ResultRegenerateAdministrativeFileIndex ResultGetAdministrativeFileIndex(hereda de ResultError) | adminFileAdministrativeFile | Documento con el índice y metadatos del expediente | signatures | ArrayList<Signature> | Firmas asociadas al índice del expedienteDataHandler | Contenido del índice electrónico del expediente electrónico administrativo |
Códigos de error Los errores de la invocación se encapsulan en ResultRegenerateAdministrativeFileIndex ResultGetAdministrativeFileIndex Código | Nombre | Descripción |
---|
1017 | ERROR_ADMINFILE_CSV_E_ID_NULOS | Debe especificar el id o el CSV del expediente | 1034 | ERROR_ADMINFILE_STATENULO | El índice del expediente solicitado está pendiente de regenerarse | 1002 | ERROR_DOCUMENTMETADATA | Error del DocumentMetadataManager | 801 | GENERIC_ERROR | Error genérico procesando la petición | .1019 | ERROR_ADMINFILE_OPENORIGINALCOPIA | El expediente carece de contenido por lo que no se puede generar el índiceEjemplo de invocación Invocación Code Block |
---|
| ParamRegenerateAdministrativeFileIndexParamGetAdministrativeFileIndex paramRegenerateAdministrativeFileIndexparamGetAdministrativeFileIndex = new ParamRegenerateAdministrativeFileIndexParamGetAdministrativeFileIndex();
paramRegenerateAdministrativeFileIndexparamGetAdministrativeFileIndex.setId("0906fca3801922bb");
paramRegenerateAdministrativeFileIndex.setIncludeAdminFile(true);
ResultRegenerateAdministrativeFileIndex ResultGetAdministrativeFileIndex result = ccsvClient.regenerateAdministrativeFileIndexgetAdministrativeFileIndex(paramRegenerateAdministrativeFileIndexparamGetAdministrativeFileIndex);
if(result.getReturnCode().equals(ReturnCode.OK){
AdministrativeFileDataHandler adminFilecontent = result.getAdminFilegetContent();
}else{
log.error(result.getErrorCode()+":"+result.getErrorMessage());
} |
|
...
Método '
...
regenerateAdministrativeFileIndex'
...
Incluye la lista de documentos existentes en el gestor documental a un expediente en estado "Abierto". Si este expediente tiene carpetas puede identificarse esta para incluirlos dentro y no en la raíz del expediente. Nota: Si se quiere incluir un documento de registro, se deberá subir a la vez, todos los documentos que tenga la relación REGISTRA y/o ADJUNTA. El resultado de incluir uno o varios documentos a un expediente, crea una relación CONTIENE entre el expediente y dichos documentos. Será necesario una vez incluidos, regenerar el índice del expediente para su actualización Regenera el índice del expediente dejando el índice antiguo en un documento aparte con relación con rol: "ES VERSIÓN DE". Recuperando si se indica en los parámetros, el objeto expediente con el índice regenerado o su firma.
...
ResultRegenerateAdministrativeFileIndex regenerateAdministrativeFileIndex(ParamRegenerateAdministrativeFileIndex paramRegenerateAdministrativeFileIndex); Parámetros de invocación Nombre | Tipo | Obligatorio | Descripción |
---|
|
...
ParamRegenerateAdministrativeFileIndex (hereda de ParamBase) | csv |
|
...
String
...
Si(1)
...
CSV del expediente donde se va a añadir el documento.
...
...
Si(1)
...
Identificador del expediente donde se va a añadir el documento.
...
contentsCsv
...
...
...
Array de CSV's de los documentos a añadir.
...
contentsId
...
String[]
...
Si(2)
...
Array de Identificadores de los documentos a añadir.
...
adminFileFolderCode
...
String
...
No(3)
...
Código de la carpeta donde incluir el documento.
...
adminFileFolderId
...
String
...
No(3)
...
Identificador de la carpeta donde incluir el documento.
...
organismCode
...
String
...
No
...
Código del organismo que se añadirá como gestor.
CSV del expediente del expediente del que se va a regenerar el índice. | id | String | Si(1) | Identificador del expediente del que se va a regenerar el índice. | 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 |
...
...
indican por defecto son falsos.(2) |
NOTA 3: Si se rellena el adminFileFolderCode no se rellena el adminFileFolderId y viceversa.(3)
...
Códigos de error
Los errores de la invocación se encapsulan en ResultAddDocumentsToAdminFile
...
Código
...
Nombre
...
Descripción
...
1017
...
ERROR_ADMINFILE_CSV_E_ID_NULOS
...
Debe especificar el id o el CSV del expediente.
...
1014
...
ERROR_ADMINFILE_CSVS_E_IDS_DOC_CONTENIDOS_NULOS
...
Debe especificar contentsId o contentsCsv de los documentos que contiene el expediente.
...
1015
...
ERROR_ADMINFILE_CSVS_E_IDS_DOC_CONTENIDOS_DUP
...
Sólo debe especificar o contentsId o contentsCsv con los documentos que contiene el expediente.
...
1028
...
ERROR_NOTEXIST_FOLDERINADMINFILE
...
No existe esa carpeta en el expediente especificado.
...
1001
...
ERROR_OPEN_STATE
...
ResultRegenerateAdministrativeFileIndex | | ResultRegenerateAdministrativeFileIndex |
---|
| ResultRegenerateAdministrativeFileIndex (hereda de ResultError) | adminFile | AdministrativeFile | Documento con el índice y metadatos del expediente | signatures | ArrayList<Signature> | Firmas asociadas al índice del expediente |
Códigos de error Los errores de la invocación se encapsulan en ResultRegenerateAdministrativeFileIndex Código | Nombre | Descripción |
---|
1002 | ERROR_DOCUMENTMETADATA | Error del DocumentMetadataManager |
|
...
| 801 | GENERIC_ERROR | Error genérico procesando la petición. | 1019 | ERROR_ADMINFILE_OPENORIGINALCOPIA | El expediente carece de contenido por lo que no se puede generar el índice. |
Ejemplo de invocación Invocación |
...
ParamRegenerateAdministrativeFileIndex |
|
...
paramRegenerateAdministrativeFileIndex = new |
|
...
ParamRegenerateAdministrativeFileIndex();
|
|
...
paramRegenerateAdministrativeFileIndex. |
|
...
...
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étodo 'addNewDocumentsToAdminFile'
...
Métodos para la gestión de los contenidos de los expedientes.
Método 'addDocumentsToAdminFile'
...
Incluye la lista de documentos existentes en el gestor documental a un expediente en estado "Abierto". Si este expediente tiene carpetas puede identificarse esta para incluirlos dentro y no en la raíz del expediente. Nota: Si se quiere incluir un documento de registro, se deberá subir a la vez, todos los documentos que tenga la relación REGISTRA y/o ADJUNTA. El resultado de incluir uno o varios documentos a un expediente, crea una relación CONTIENE entre el expediente y dichos documentos. Será necesario una vez incluidos, regenerar el índice del expediente para su actualización.
...
ResultAddDocumentsToAdminFile addDocumentsToAdminFile(ParamAddDocumentsToAdminFile paramAddDocumentsToAdminFile); Parámetros de invocación Nombre | Tipo | Obligatorio | Descripción |
---|
|
...
ParamAddDocumentsToAdminFile (hereda de ParamBase) | csv | String | Si(1) | CSV del expediente donde se va a añadir el documento. | id | String | Si(1) | Identificador del expediente donde se va a añadir el documento. |
|
...
...
...
folderId
...
String
...
No
...
Identificador de la carpeta de Documentum.
...
aclName
...
String
...
No
...
Nombre de la lista de control de accesos al fichero.
CSV's de los documentos a añadir. | contentsId | String[] | Si(2) | Array de Identificadores de los documentos a añadir. | adminFileFolderCode | String | No(3) | Código de la carpeta donde incluir |
|
...
el documento. | adminFileFolderId | String | No(3) | Identificador de la carpeta donde incluir |
|
...
el documento. | organismCode | String | No | Código del organismo que se añadirá como gestor. |
NOTA: Si se rellena el csv no se rellena el campo id y viceversa. |
...
(1) NOTA 2: Si se rellena el contentsCsv no se rellena el contentsId y viceversa.(2) NOTA 3: Si se rellena el adminFileFolderCode no se rellena el adminFileFolderId y viceversa.(3) Parámetros de respuesta |
...
| ResultAddDocumentsToAdminFile |
---|
|
|
|
...
| ResultAddDocumentsToAdminFile |
---|
|
|
|
...
...
id
...
...
Identificadores de los documentos creados
Códigos de error Los errores de la invocación se encapsulan |
...
en ResultAddDocumentsToAdminFile Código | Nombre | Descripción |
---|
1017 | ERROR_ADMINFILE_CSV_E_ID_NULOS | Debe especificar el id o el CSV del expediente. |
|
...
1014 | ERROR_ADMINFILE_CSVS_E_IDS_DOC_CONTENIDOS_ |
|
...
...
contentsId o contentsCsv de los documentos que contiene el expediente. | 1015 | ERROR_ADMINFILE_CSVS_E_IDS_DOC_CONTENIDOS_DUP | Sólo debe especificar o contentsId o contentsCsv con los documentos que contiene el expediente. | 1028 | ERROR_NOTEXIST_FOLDERINADMINFILE | No existe esa carpeta en el expediente especificado. | 1001 | ERROR_OPEN_STATE | No se puede modificar la estructura de un expediente que no esté en estado Abierto. | 1002 | ERROR_DOCUMENTMETADATA | Error del DocumentMetadataManager. | 801 | GENERIC_ERROR | Error genérico procesando la petición. |
Ejemplo de invocación Invocación |
...
ParamAddDocumentsToAdminFile |
|
...
paramAddDocumentsToAdminFile = new |
|
...
ParamAddDocumentsToAdminFile();
// |
|
...
añadimos 2 documentos ya existentes identificados por su id en una carpeta de un expediente
paramAddDocumentsToAdminFile.setId("0906fca3801922bb");
String[] ids = {"0907lca3801958jk", "0907lca3587459jk"}
paramAddDocumentsToAdminFile.setContentsId(ids);
paramAddDocumentsToAdminFile.setAdminFileFolderCode("codigoCarpeta");
ResultAddDocumentsToAdminFile result = ccsvClient. |
|
...
...
paramAddDocumentsToAdminFile);
if(result.getReturnCode().equals(ReturnCode. |
|
...
ERROR){
log.error(result.getErrorCode()+":"+result.getErrorMessage());
} |
|
Método 'addAdministrativeFileToAdminFile'
...
Expand |
---|
|
Signatura ResultAddAdministrativeFileToAdminFile addAdministrativeFileToAdminFile(ParamAddAdministrativeFileToAdminFile paramAddAdministrativeFileToAdminFile); Parámetros de invocación Nombre | Tipo | Obligatorio | Descripción |
---|
ParamAddAdministrativeFileToAdminFile(hereda de ParamBase) | csv | String | Si(1) | CSV del expediente donde se va a añadir el documento. | id | String | Si(1) | Identificador del expediente donde se va a añadir el documento. | contentCsv | String | Si(2) | CSV del expediente a añadir | contentId | String | Si(2) | Identificador del expediente a añadir | adminFileFolderCode | String | No(3) | Código de la carpeta donde incluir el documento. | adminFileFolderId | String | No(3) | Identificador de la carpeta donde incluir el documento. |
NOTA: Si se rellena el csv no se rellena el campo id y viceversa.(1) NOTA 2: Si se rellena el contentCsv no se rellena el campo contentId y viceversa.(2) NOTA 3: Si se rellena el adminFileFolderCode no se rellena el adminFileFolderId y viceversa.(3) Parámetros de respuesta Nombre | Tipo | Descripción |
---|
Anchor |
---|
| ResultAddAdministrativeFileToAdminFile |
---|
| ResultAddAdministrativeFileToAdminFile |
---|
| ResultAddAdministrativeFileToAdminFile (hereda de ResultError) |
Códigos de error Los errores de la invocación se encapsulan en ResultAddAdministrativeFileToAdminFile Código | Nombre | Descripción |
---|
1017 | ERROR_ADMINFILE_CSV_E_ID_NULOS | Debe especificar el id o el CSV del expediente. | 1007 | ERROR_ADMINFILE_CSVS_E_IDS_DOC_CONTENIDOS_NULOS | Debe especificar el id o el CSV del documento contenido del expediente | 1028 | ERROR_NOTEXIST_FOLDERINADMINFILE | No existe esa carpeta en el expediente especificado. | 1001 | ERROR_OPEN_STATE | No se puede modificar la estructura de un expediente que no esté en estado Abierto. | 1002 | ERROR_DOCUMENTMETADATA | Error del DocumentMetadataManager. | 801 | GENERIC_ERROR | Error genérico procesando la petición. |
Ejemplo de invocación Invocación Code Block |
---|
| ParamAddAdministrativeFileToAdminFile paramAddAdministrativeFileToAdminFile = new ParamAddAdministrativeFileToAdminFile();
paramAddAdministrativeFileToAdminFile.setId("09587425558554jk");
paramAddAdministrativeFileToAdminFile.setContentId("098745255456654rr");
ResultAddAdministrativeFileToAdminFile result = ccsvClient.AddAdministrativeFileToAdminFile(paramAddAdministrativeFileToAdminFile);
if(result.getReturnCode().equals(ReturnCode.ERROR){
log.error(result.getErrorCode()+":"+result.getErrorMessage());
} |
|
...
Expand |
---|
|
Signatura ResultDeleteDocumentFromAdminFile deleteDocumentFromAdminFile(ParamDeleteDocumentFromAdminFile paramDeleteDocumentFromAdminFile ); Parámetros de invocación Nombre | Tipo | Obligatorio | Descripción |
---|
ParamDeleteDocumentFromAdminFile (hereda de ParamBase) | csv | String | Si(1) | CSV del expediente donde se va a buscar el documento a borrar. | id | String | Si(1) | Identificador del expediente donde se va a buscar el documento a borrar. | contentCsv | String | Si(2) | CSV del documento a borrar. | contentId | String | Si(2) | Identificador del documento a borrar. | adminFileFolderId | String | No | Identificador de la carpeta que se desea eliminar. |
NOTA: Si se rellena el csv no se rellena el campo id y viceversa.(1) NOTA 2: Si se rellena el contentCsv no se rellena el campo contentId y viceversa.(2) Parámetros de respuesta Nombre | Tipo | Descripción |
---|
Anchor |
---|
| ResultDeleteDocumentFromAdminFile |
---|
| ResultDeleteDocumentFromAdminFile |
---|
| ResultDeleteDocumentFromAdminFile (hereda de ResultError) |
Códigos de error Los errores de la invocación se encapsulan en ResultDeleteDocumentFromAdminFile Código | Nombre | Descripción |
---|
1017 | ERROR_ADMINFILE_CSV_E_ID_NULOS | Debe especificar el id o el CSV del expediente. | 1018 | ERROR_STATEORIGINALCOPIA | No se puede borrar del expediente documentos en estado Original o Copia | 1007 | ERROR_ADMINFILE_CSV_E_ID_DOC_CONTENIDO_NULOS | Debe especificar el id o el CSV del documento contenido del expediente | 1001 | ERROR_OPEN_STATE | No se puede modificar la estructura de un expediente que no esté en estado Abierto. | 1029 | ERROR_NOTEXIST_DOCINADMINFILE | No existe ese documento en el expediente especificado | 1002 | ERROR_DOCUMENTMETADATA | Error del DocumentMetadataManager. | 801 | GENERIC_ERROR | Error genérico procesando la petición. |
Ejemplo de invocación Invocación Code Block |
---|
| ParamDeleteDocumentFromAdminFile paramDeleteDocumentFromAdminFile = new ParamDeleteDocumentFromAdminFile();
paramDeleteDocumentFromAdminFile.setId("0925745454564gf");
paramDeleteDocumentFromAdminFile.setContentId("09254654446586ff");
ResultDeleteDocumentFromAdminFile result = ccsvClient.deleteDocumentFromAdminFile(paramDeleteDocumentFromAdminFile);
if(result.getReturnCode().equals(ReturnCode.ERROR){
log.error(result.getErrorCode()+":"+result.getErrorMessage());
} |
|
...
Expand |
---|
|
Signatura ResultMoveDocumentToRecycleFolder moveDocumentToRecycleFolder(ParamMoveDocumentToRecycleFolder paramMoveDocumentToRecycleFolder); Parámetros de invocación Nombre | Tipo | Obligatorio | Descripción |
---|
ParamMoveDocumentToRecycleFolder(hereda de ParamBase) | adminFileCsv | String | Si(1) | csv del expediente donde se encuentra el documento a mover, en caso de que el documento esté directamente en el expediente. | adminFileId | String | Si(1) | Identificador en Documentum del expediente donde se encuentra el documento a mover, en caso de que el documento esté directamente en el expediente. | documentCsv | String | Si(2) | csv del documento a mover. | documentId | String | Si(2) | Identificador en Documentum del documento a mover. | reasonToMove | String | Si | Razón por la que se solicita el movimiento a la papelera de reciclaje. |
NOTA: Si se rellena el adminFileCsv no se rellena el campo adminFileId y viceversa.(1) NOTA 2: Si se rellena el documentCsv no se rellena el campo documentId y viceversa.(2) Parámetros de respuesta Nombre | Tipo | Descripción |
---|
Anchor |
---|
| ResultMoveDocumentToRecycleFolder |
---|
| ResultMoveDocumentToRecycleFolder |
---|
| ResultMoveDocumentToRecycleFolder(hereda de ResultError) |
Códigos de error Los errores de la invocación se encapsulan en 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 ResultCreateAdministrativeFileFolder createAdministrativeFileFolder(ParamCreateAdministrativeFileFolder paramCreateAdministrativeFileFolder); Parámetros de invocación Nombre | Tipo | Obligatorio | Descripción |
---|
ParamCreateAdministrativeFileFolder (hereda de ParamBase) | csv | String | Si(1) | CSV del expediente. | id | String | Si(1) | Identificador del expediente. | adminFileFolder | AdministrativeFileFolder | Si(2) | Carpeta que se desea crear. |
NOTA: Si se rellena el csv no se rellena el campo id y viceversa.(1) NOTA 2: Necesitaremos el code y el name del AdminFileFolder que queremos crear..(2) Parámetros de respuesta Nombre | Tipo | Descripción |
---|
Anchor |
---|
| ResultCreateAdministrativeFileFolder |
---|
| ResultCreateAdministrativeFileFolder |
---|
| ResultCreateAdministrativeFileFolder (hereda de ResultError) | adminFileFolderId | String | Identificador de la carpeta que se ha creado. |
Códigos de error Los errores de la invocación se encapsulan en ResultCreateAdministrativeFileFolder Código | Nombre | Descripción |
---|
1017 | ERROR_ADMINFILE_CSV_E_ID_NULOS | Debe especificar el id o el CSV del expediente. | 1030 | ERROR_ADMINFILEFOLDER_CREATE | Faltan datos de la carpeta que se desea crear | 1001 | ERROR_OPEN_STATE | No se puede modificar la estructura de un expediente que no esté en estado Abierto | 1035 | ERROR_ADMINFILEFOLDER_CREATE_CODE | El código de la carpeta no puede tener más de 20 caracteres | 1036 | ERROR_ADMINFILEFOLDER_CREATE_NAME | El nombre de la carpeta no puede tener más de 80 caracteres | 1002 | ERROR_DOCUMENTMETADATA | Error del DocumentMetadataManager. | 801 | GENERIC_ERROR | Error genérico procesando la petición. |
Ejemplo de invocación Invocación Code Block |
---|
| ParamCreateAdministrativeFileFolder paramCreateAdministrativeFileFolder = new ParamCreateAdministrativeFileFolder();
// adminFileFolder es un objeto de la clase AdminFileFolder que contiene el code y el name de la carpeta que queremos crear.
paramCreateAdministrativeFileFolder.setAdminFileFolder(adminFileFolder);
paramCreateAdministrativeFileFolder.setId("09254644654456hk");
ResultCreateAdministrativeFileFolder result = ccsvClient.createAdministrativeFileFolder(paramCreateAdministrativeFileFolder);
if(result.getReturnCode().equals(ReturnCode.OK){
String adminFileFolderId = result.getAdminFileFolderId();
}else{
log.error(result.getErrorCode()+":"+result.getErrorMessage());
} |
|
...
Expand |
---|
|
Signatura ResultDeleteAdministrativeFileFolder deleteAdministrativeFileFolder(ParamDeleteAdministrativeFileFolder paramDeleteAdministrativeFileFolder); Parámetros de invocación Nombre | Tipo | Descripción |
---|
ParamDeleteAdministrativeFileFolder (hereda de ParamBase) | csv | String(1) | CSV del expediente. | id | String(1) | Identificador del expediente. | adminFileFolderCode | String(2) | Código de la carpeta que se desea eliminar | adminFileFolderId | String(2) | Identificador de la carpeta que se desea eliminar |
NOTA: Si se rellena el csv no se rellena el campo id y viceversa.(1) NOTA 2: Si se rellena el adminFileFolderCode no se rellena el campo adminFileFolderId y viceversa.(2) Parámetros de respuesta Nombre | Tipo | Descripción |
---|
Anchor |
---|
| ResultDeleteAdministrativeFileFolder |
---|
| ResultDeleteAdministrativeFileFolder |
---|
| ResultDeleteAdministrativeFileFolder(hereda de ResultError) |
Códigos de error Los errores de la invocación se encapsulan en ResultDeleteAdministrativeFileFolder Código | Nombre | Descripción |
---|
1017 | ERROR_ADMINFILE_CSV_E_ID_NULOS | Debe especificar el id o el CSV del expediente. | 1031 | ERROR_ADMINFILEFOLDER_CREATE | Faltan datos de la carpeta que se desea crear | 1001 | ERROR_OPEN_STATE | No se puede modificar la estructura de un expediente que no esté en estado Abierto | 1028 | ERROR_NOTEXIST_FOLDERINADMINFILE | No existe esa carpeta en el expediente especificado | 1002 | ERROR_DOCUMENTMETADATA | Error del DocumentMetadataManager. | 801 | GENERIC_ERROR | Error genérico procesando la petición. |
Ejemplo de invocación Invocación Code Block |
---|
| ParamDeleteAdministrativeFileFolder paramDeleteAdministrativeFileFolder = new ParamDeleteAdministrativeFileFolder();
paramDeleteAdministrativeFileFolder.setCsv("CCSV54641878471CCSV");
paramDeleteAdministrativeFileFolder.setAdminFileFolderId("095464654564j");
ResultDeleteAdministrativeFileFolder result = ccsvClient.deleteAdministrativeFileFolder(paramDeleteAdministrativeFileFolder);
if(result.getReturnCode().equals(ReturnCode.ERROR){
log.error(result.getErrorCode()+”:”+result.getErrorMessage());
} |
|
...
Expand |
---|
|
Signatura ResultGetAdministrativeFileFolder getAdministrativeFileFolder(ParamGetAdministrativeFileFolder paramGetAdministrativeFileFolder); Parámetros de invocación Nombre | Tipo | Obligatorio | Descripción |
---|
ParamGetAdministrativeFileFolder (hereda de ParamBase) | csv | String | Si(1) | CSV del expediente. | id | String | Si(1) | Identificador del expediente. | adminFileFolderCode | String | Si(2) | Código de la carpeta que se desea eliminar | adminFileFolderId | String | Si(2) | Identificador de la carpeta que se desea eliminar | metadata | String[] | No(3) | Lista de atributos que se desean recuperar de los documentos de la carpeta | includeContent | boolean | Si | Indica se se desean recuperar los contenidos de los documentos de la carpeta |
NOTA: Si se rellena el csv no se rellena el campo id y viceversa. NOTA 2: Si se rellena el adminFileFolderCode no se rellena el campo adminFileFolderId y viceversa. NOTA 3:Por defecto añade los metadatos: código de la carpeta, nombre de la carpeta, descripción tipo documento, CSV, estado del documento, fecha captura, estado del expediente, fecha apertura del expediente y número de expediente.(3) Parámetros de respuesta Códigos de error Los errores de la invocación se encapsulan en ResultGetAdministrativeFileFolder Código | Nombre | Descripción |
---|
1017 | ERROR_ADMINFILE_CSV_E_ID_NULOS | Debe especificar el id o el CSV del expediente. | 1031 | ERROR_ADMINFILEFOLDER_CREATE | Faltan datos de la carpeta que se desea crear | 1028 | ERROR_NOTEXIST_FOLDERINADMINFILE | No existe esa carpeta en el expediente especificado | 1002 | ERROR_DOCUMENTMETADATA | Error del DocumentMetadataManager. | 801 | GENERIC_ERROR | Error genérico procesando la petición. |
Ejemplo de invocación Invocación Code Block |
---|
| ParamGetAdministrativeFileFolder paramGetAdministrativeFileFolder = new ParamGetAdministrativeFileFolder();
paramGetAdministrativeFileFolder.setCsv("CCSV54641878471CCSV");
paramGetAdministrativeFileFolder.setAdminFileFolderId("095464654564j");
paramGetAdministrativeFileFolder.setIncludeContent(true);
ResultGetAdministrativeFileFolder result = ccsvClient.getAdministrativeFileFolder(paramGetAdministrativeFileFolder);
if(result.getReturnCode().equals(ReturnCode.OK){
AdministrativeFileFolder adminFileFolder = result.getAdminFileFolder();
AdministrativeFileRelation[] folderContents = result.getFolderContents();
}else{
log.error(result.getErrorCode()+":"+result.getErrorMessage());
} |
|
Método 'moveDocumentToFolder'
...
NOTA: Se recomienda el uso del método moveDocumentsToFolder por motivos de eficiencia.
Mueve un documento a una carpeta especificada. Si ya está dentro de una carpeta, se deberá cambiar la relación "CONTIENE" a la nueva carpeta conservando la fecha que es la de incorporación del documento al expediente. Deberá añadir el expediente a la tabla de regeneración de índices para que el proceso nocturno se encargue de regenerarlo.
Expand |
---|
|
Signatura ResultMoveDocumentToFolder moveDocumentToFolder(ParamMoveDocumentToFolder paramMoveDocumentToFolder); Parámetros de invocación Nombre | Tipo | Obligatorio | Descripción |
---|
ParamMoveDocumentToFolder(hereda de ParamBase) | csv | String | Si(1) | CSV del expediente. | id | String | Si(1) | Identificador del expediente. | contentCsv | String | Si(2) | CSV del documento que se va a mover | contentId | String | Si(2) | Identificador del documento que se va a mover | adminFileFolderCode | String | Si(3) | Código de la carpeta a la que se desea mover el documento | adminFileFolderId | String | Si(3) | Identificador de la carpeta a la que se desea mover el documento |
NOTA: Si se rellena el csv no se rellena el campo id y viceversa.(1) NOTA 2: Si se rellena el contentCsv no se rellena el campo contentId y viceversa.(2) NOTA 3:Si se rellena el adminFileFolderCode no se rellena el campo adminFileFolderId y viceversa.(3) Parámetros de respuesta Nombre | Tipo | Descripción |
---|
Anchor |
---|
| ResultMoveDocumentToFolder |
---|
| ResultMoveDocumentToFolder |
---|
| ResultMoveDocumentToFolder(hereda de ResultError) |
Códigos de error Los errores de la invocación se encapsulan en ResultMoveDocumentToFolder Código | Nombre | Descripción |
---|
1017 | ERROR_ADMINFILE_CSV_E_ID_NULOS | Debe especificar el id o el CSV del expediente. | 1031 | ERROR_ADMINFILEFOLDER_CREATE | Faltan datos de la carpeta que se desea crear | 1007 | ERROR_ADMINFILE_CSV_E_ID_DOC_CONTENIDO_NULOS | Debe especificar el id o el CSV del documento contenido del expediente | 1001 | ERROR_OPEN_STATE | No se puede modificar la estructura de un expediente que no esté en estado Abierto | 1028 | ERROR_NOTEXIST_FOLDERINADMINFILE | No existe esa carpeta en el expediente especificado | 1029 | ERROR_NOTEXIST_DOCINADMINFILE | No existe ese documento en el expediente especificado | 1002 | ERROR_DOCUMENTMETADATA | Error del DocumentMetadataManager. | 801 | GENERIC_ERROR | Error genérico procesando la petición. |
Ejemplo de invocación Invocación Code Block |
---|
| ParamMoveDocumentToFolder paramMoveDocumentToFolder = new ParamMoveDocumentToFolder();
paramMoveDocumentToFolder.setCsv("CCSV54641878471CCSV");
paramMoveDocumentToFolder.setContentCsv("CCSV54646484849CCSV");
paramMoveDocumentToFolder.setAdminFileFolderId("095464654564j");
ResultMoveDocumentToFolder result = ccsvClient.moveDocumentToFolder(paramMoveDocumentToFolder);
if(result.getReturnCode().equals(ReturnCode.ERROR){
log.error(result.getErrorCode()+”:”+result.getErrorMessage());
} |
|
...
Expand |
---|
|
Signatura ResultMoveDocumentsToFolder moveDocumentsToFolder(ParamMoveDocumentsToFolder paramMoveDocumentsToFolder); Parámetros de invocación Nombre | Tipo | Obligatorio | Descripción |
---|
ParamMoveDocumentsToFolder (hereda de ParamBase) | csv | String | Si(1) | CSV del expediente. | id | String | Si(1) | Identificador del expediente. | contentsCsv | String[] | Si(2) | Lista de CSV's de los documentos que se va a mover | contentsId | String[] | Si(2) | Lista de Identificadores de los documentos que se va a mover | adminFileFolderCode | String | Si(3) | Código de la carpeta a la que se desea mover el documento | adminFileFolderId | String | Si(3) | Identificador de la carpeta a la que se desea mover el documento |
NOTA: Si se rellena el csv no se rellena el campo id y viceversa.(1) NOTA 2: Si se rellena el contentsCsv no se rellena el campo contentsId y viceversa.(2) NOTA 3:Si se rellena el adminFileFolderCode no se rellena el campo adminFileFolderId y viceversa.(3) Parámetros de respuesta Nombre | Tipo | Descripción |
---|
Anchor |
---|
| ResultMoveDocumentsToFolder |
---|
| ResultMoveDocumentsToFolder |
---|
| ResultMoveDocumentsToFolder(hereda de ResultError) |
Códigos de error Los errores de la invocación se encapsulan en ResultMoveDocumentsToFolder Código | Nombre | Descripción |
---|
1017 | ERROR_ADMINFILE_CSV_E_ID_NULOS | Debe especificar el id o el CSV del expediente. | 1031 | ERROR_ADMINFILEFOLDER_CREATE | Faltan datos de la carpeta que se desea crear | 1014 | ERROR_ADMINFILE_CSVS_E_IDS_DOC_CONTENIDOS_NULOS | Debe especificar contentsId o contentsCsv de los documentos que contiene el expediente | 1015 | ERROR_ADMINFILE_CSVS_E_IDS_DOC_CONTENIDOS_DUP | Sólo debe especificar o contentsId o contentsCsv con los documentos que contiene el expediente | 1001 | ERROR_OPEN_STATE | No se puede modificar la estructura de un expediente que no esté en estado Abierto | 1028 | ERROR_NOTEXIST_FOLDERINADMINFILE | No existe esa carpeta en el expediente especificado | 1029 | ERROR_NOTEXIST_DOCINADMINFILE | No existe ese documento en el expediente especificado | 1002 | ERROR_DOCUMENTMETADATA | Error del DocumentMetadataManager. | 801 | GENERIC_ERROR | Error genérico procesando la petición. |
Ejemplo de invocación Invocación Code Block |
---|
| ParamMoveDocumentsToFolder paramMoveDocumentsToFolder = new ParamMoveDocumentsToFolder();
paramMoveDocumentsToFolder.setCsv("CCSV54641878471CCSV");
// contentsCsv es un String[] que contiene los csv's de los documentos que queremos mover
paramMoveDocumentsToFolder.setContentsCsv(contentsCsv);
paramMoveDocumentsToFolder.setAdminFileFolderId("095464654564j");
ResultMoveDocumentsToFolder result =ccsvClient.moveDocumentsToFolder(paramMoveDocumentsToFolder);
if(result.getReturnCode().equals(ReturnCode.ERROR){
log.error(result.getErrorCode()+”:”+result.getErrorMessage());
} |
|
...
Expand |
---|
|
Signatura ResultRemoveDocumentFromFolder removeDocumentFromFolder(ParamRemoveDocumentFromFolder paramRemoveDocumentFromFolder); Parámetros de invocación Nombre | Tipo | Obligatorio | Descripción |
---|
ParamRemoveDocumentFromFolder (hereda de ParamBase) | csv | String | Si(1) | CSV del expediente. | id | String | Si(1) | Identificador del expediente. | contentsCsv | String[] | Si(2) | CSV del documento que se va a eliminar | contentsId | String[] | Si(2) | Identificador del documento que se va eliminar | adminFileFolderCode | String | Si(3) | Código de la carpeta de la que se desea quitar el documento | adminFileFolderId | String | Si(3) | Identificador de la carpeta de la que se desea quitar el documento |
NOTA: Si se rellena el csv no se rellena el campo id y viceversa.(1) NOTA 2: Si se rellena el contentsCsv no se rellena el campo contentsId y viceversa.(2) NOTA 3:Si se rellena el adminFileFolderCode no se rellena el campo adminFileFolderId y viceversa.(3) Parámetros de respuesta Nombre | Tipo | Descripción |
---|
Anchor |
---|
| ResultRemoveDocumentFromFolder |
---|
| ResultRemoveDocumentFromFolder |
---|
| ResultRemoveDocumentFromFolder (hereda de ResultError) |
Códigos de error Los errores de la invocación se encapsulan en ResultRemoveDocumentFromFolder Código | Nombre | Descripción |
---|
1017 | ERROR_ADMINFILE_CSV_E_ID_NULOS | Debe especificar el id o el CSV del expediente. | 1031 | ERROR_ADMINFILEFOLDER_CREATE | Faltan datos de la carpeta que se desea crear | 1007 | ERROR_ADMINFILE_CSV_E_ID_DOC_CONTENIDO_NULOS | Debe especificar el id o el CSV del documento contenido del expediente | 1001 | ERROR_OPEN_STATE | No se puede modificar la estructura de un expediente que no esté en estado Abierto | 1028 | ERROR_NOTEXIST_FOLDERINADMINFILE | No existe esa carpeta en el expediente especificado | 1029 | ERROR_NOTEXIST_DOCINADMINFILE | No existe ese documento en el expediente especificado | 1027 | ERROR_NOTEXIST_DOCINFOLDER | No existe ese documento en la carpeta especificada | 1002 | ERROR_DOCUMENTMETADATA | Error del DocumentMetadataManager. | 801 | GENERIC_ERROR | Error genérico procesando la petición. |
Ejemplo de invocación Invocación Code Block |
---|
| ParamRemoveDocumentFromFolder paramRemoveDocumentFromFolder = new ParamRemoveDocumentFromFolder();
paramRemoveDocumentFromFolder.setCsv("CCSV54641878471CCSV");
paramRemoveDocumentFromFolder.setContentCsv("CCSV1984991484CCSV");
paramRemoveDocumentFromFolder.setAdminFileFolderId("095464654564j");
ResultRemoveDocumentFromFolder result = ccsvClient.removeDocumentFromFolder (paramRemoveDocumentFromFolder);
if(result.getReturnCode().equals(ReturnCode.ERROR){
log.error(result.getErrorCode()+":"+result.getErrorMessage());
} |
|
...
Expand |
---|
|
Signatura ResultLastAddedContents lastAddedContents(ParamLastAddedContents paramLastAddedContents); Parámetros de invocación Nombre | Tipo | Obligatorio | Descripción |
---|
ParamLastAddedContents (hereda de 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());
} |
|
...