| Table of Contents |
|---|
Servicio IDocumentMetadataSignatureServicePortType
A continuación se muestran todos los métodos referentes a la gestión de documentos, carpetas , relaciones etc.
Métodos de manejo de documentos.
Método 'createDocument'
...
Almacena un documento en el gestor Documental Documentum.
...
| Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Signatura ResultGetSubstituteDocument getSubstituteDocument(ParamGetSubstituteDocument paramGetSubstituteDocument) Parámetros de invocación
Parámetros de respuesta
Códigos de error Los errores de la invocación se encapsulan en ResultGetSubstituteDocument
Ejemplo de invocación Invocación
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Métodos de gestión de enlaces de documentos.
Método 'createDocumentLink'
...
| Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
Signatura ResultDeleteDocumentLink deleteDocumentLink(ParamDeleteDocumentLink paramDeleteDocumentLink). Parámetros de invocación
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 ResultDeleteDocumentLink
Ejemplo de invocación Invocación
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
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
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 ResultGetDocumentSignatures.
Ejemplo de invocación Invocación
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Métodos de gestión de metadatos.
Método
| Anchor | ||||
|---|---|---|---|---|
|
...
| Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Signatura ResultDeleteMetadata deleteMetadata(ParamDeleteMetadata paramDeleteMetadata). Parámetros de invocación
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 ResultUpdateMetadata
Ejemplo de invocación Invocación
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Métodos de gestión de relaciones.
Método 'createRelationship'
...
| Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Signatura ResultGetAllRelatedDocuments getAllRelatedDocuments(ParamGetAllRelatedDocuments paramGetAllRelatedDocuments). Parámetros de invocación
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 ResultGetAllRelatedDocuments
Ejemplo de invocación Invocación
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Métodos de gestión de trazas.
Método 'getTraces'
...
Recupera las trazas de un documento o expediente.
| Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Signatura ResultGetTraces getTraces(ParamGetTraces paramGetTraces). Parámetros de invocación
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 ResultGetTraces
Ejemplo de invocación Invocación
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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
Ejemplo de invocación Invocación
| ||||||||||||||||||||||||||||||||||||||
Métodos obsoletos
Debido a la definición actual del servicio de gestión documentos existen varios métodos que han quedado obsoletos ya que pueden realizarse esas mismas tareas desde un método general cambiando ciertos parámetros. Con el fin de mejorar la mantenibilidad y el soporte del sistema se ha decidido que en próximas versiones se eliminaran los siguientes métodos.(En cada uno de los métodos se marca aquel que se recomienda usar en lugar del que se ha marcado como obsoleto)
...
Se recomienda usar el método updateMetadata ya que puede usarse independientemente del tipo de metadato que se intenta actualizar.
Servicio ISendAdminFileCloudWSPortType
El protocolo de Remisión en la Nube pretende ser un estándar para el intercambio de expedientes electrónicos en formato ENI (Esquema Nacional de Interoperabilidad) entre dos administraciones públicas cualesquiera, sean estas administrativas o judiciales.
Método 'createDocumentXml'
Crea un documento XML.
...
| title | Ver detalles |
|---|
Signatura
...
.
...
Parámetros de invocación
...
Nombre
...
Tipo
...
Obligatorio
...
Descripción
...
ParamCreateDocumentXml (hereda de ParamBase)
...
xml
...
DataHandler
...
Si
...
Xml del documento
...
agent
...
...
Si
...
Relación con meta-dato estructurado de tipo agente
...
name
...
String
...
No
...
Nombre del documento
...
procedureCode
...
String
...
No
...
Código de procedimiento
Parámetros de respuesta
...
Nombre
...
Tipo
...
Descripción
...
csv
...
String
...
Código csv asociado al documento que se ha creado.
...
name
...
String
...
Nombre del documento que se ha creado.
...
extension
...
String
...
Extensión del documento que se ha creado.
Códigos de error
Los errores de la invocación se encapsulan en ResultCreateDocumentXml
...
Código
...
Nombre
...
Descripción
...
203
...
ERROR_DATAHANDLER_ARRAYBYTE_CSV
...
Error al pasar dataHandler a ArrayByte
...
1208
...
ERROR_PARSE_XML
...
Hubo un error al leer los datos recibidos
...
101
...
ERROR_CONEXION_PAPIRO
...
Error de conexión con documentum
...
1214
...
ERROR_INDEX_FILE_EXIST
...
El documento eni ya existe.
Ejemplo de invocación
Invocación
| Code Block | ||
|---|---|---|
| ||
ParamCreateDocumentXml paramCreateDocumentXml = new ParamCreateDocumentXml();
paramCreateDocumentXml.setAgent(agent);//se entiende que agent es Agent correctamente creado
paramCreateDocumentXml.setXml(documento);//se entiende que document es el Datahandler de un documento xml
ResultCreateDocumentXml result= cssvClient.createDocumentXml(paramCreateDocumentXml);
if(result.getReturnCode().equals(ReturnCode.ERROR){
log.error(result.getErrorCode()+":"+result.getErrorMessage());
} |
Método 'createIndexXml'
Crea un índice para documentos XML.
...
| title | Ver detalles |
|---|
Signatura
ResultCreateIndexXml createIndexXml(ParamCreateIndexXml paramCreateIndexXml).
Parámetros de invocación
...
Nombre
...
Tipo
...
Obligatorio
...
Descripición
...
ParamCreateIndexXml (hereda de ParamBase)
...
xml
...
DataHandler
...
Si
...
Xml del índice.
...
agent
...
...
Si
...
Relación con metadato estructurado de tipo agente
...
name
...
String
...
No
...
Nombre del documento índice.
...
procedureCode
...
String
...
No
...
Código de procedimiento
...
type
...
String
...
Si
...
Tipo del expediente donde se crea el índice.
...
number
...
String
...
Si
...
Numero del expediente donde se crea el índice.
...
description
...
String
...
Si
...
Descripción del expediente donde se crea el índice.
Parámetros de respuesta
...
Nombre
...
Tipo
...
Descripción
...
csv
...
String
...
Código csv asociado al documento índice que se ha creado.
...
name
...
String
...
Nombre del documento índice que se ha creado.
...
extension
...
String
...
Extensión del documento índice que se ha creado.
...
Los errores de la invocación se encapsulan en ResultCreateIndexXml
...
Código
...
Nombre
...
Descripción
...
203
...
ERROR_DATAHANDLER_ARRAYBYTE_CSV
...
Error al pasar dataHandler a ArrayByte
...
1208
...
ERROR_PARSE_XML
...
Hubo un error al leer los datos recibidos
...
101
...
ERROR_CONEXION_PAPIRO
...
Error de conexión con documentum
...
1214
...
ERROR_INDEX_FILE_EXIST
...
El documento eni ya existe.
Ejemplo de invocación
Invocación
| Code Block | ||
|---|---|---|
| ||
ParamCreateIndexXml paramCreateIndexXml = new ParamCreateIndexXml();
paramCreateIndexXml.setName(“Nombre”);
paramCreateDocumentXml.setXml(documento);
paramCreateDocumentXml.setType("Tipo del expediente donde se crea el indice");
paramCreateDocumentXml.setNumber("Número del expediente donde se crea el indice");
paramCreateDocumentXml.setDescription("Descripción del expediente donde se crea el indice");
ResultCreateIndexXml result= cssvClient.createIndexXml(paramCreateIndexXml);
if(result.getReturnCode().equals(ReturnCode.ERROR){
log.error(result.getErrorCode()+":"+result.getErrorMessage());
}
|
Método 'prepareXmlToInside'
Prepara el documento xml de un expediente para su remisión a terceros.
...
| title | Ver detalles |
|---|
Signatura
void prepareXmlToInside(ParamPrepareXmlToInside paramPrepareXmlToInside)
Parámetros de invocación
...
Nombre
...
Tipo
...
Obligatorio
...
Descripción
...
ParamPrepareXmlToInside (hereda de ParamBase)
...
expedienteCSV
...
String
...
Si
...
CSV del Expediente
...
codigoDir3
...
String
...
Si
...
Código dir3.
...
userNif
...
String
...
Si
...
Nif de la persona que realiza la petición.
...
asunto
...
String
...
No
...
Asunto del xml que se prepara para enviar. Máximo 150 caracteres
...
adjuntoCSV
...
String
...
No
...
Código csv adjunto al documento que se prepara para enviar.
...
Id de la peticion
...
String
...
No
...
Id de la petición.
...
description
...
String
...
No
...
Descripción del expediente donde se crea el índice.
...
motivacion
...
String
...
No
...
Motivación. Máximo 256
...
plazoDisponibilidad
...
Date
...
No
...
Fecha limite hasta la que el expediente//documento esta disponible
...
flagAdminFileJustice
...
boolean
...
Si
...
Indica si se remite o no a justicia
...
paramSendJustice
...
...
Si
...
Parámetros adicionales para remitir a justicia.
NOTA: En caso de indicar como true el parametro flagAdminFileJustice habra que indicar el objeto paramSendJustice.
Parámetros de respuesta
Al ser un método void, no devolverá nada.
Códigos de error
Los errores de la invocación se encapsulan en ResultGetAdministrativeFile
...
Código
...
Nombre
...
Descripción
...
1200
...
ERROR_INSIDE_ALTA_EXPEDIENTE
...
Se ha producido un error con el servicio Inside
...
193
...
ERROR_BASEDATOS_CCSV
...
Error al conectar con la Base de Datos CSVs
...
801
...
GENERIC_ERROR
...
Error genérico procesando la petición
Ejemplo de invocación
Invocación
| Code Block | ||
|---|---|---|
| ||
ParamPrepareXmlToInside prepareXmlToInside= new ParamPrepareXmlToInside();
paramPrepareXmlToInside.setExpedienteCSV("CSV5422552326");
paramPrepareXmlToInside.setCodigoDir3("asdasd");
paramPrepareXmlToInside.setUserNif("0000000T");
paramPrepareXmlToInside.setFlagAdminFileJustice("false");
ResultPrepareXmlToInside result= cssvClient.prepareXmlToInside(paramPrepareXmlToInside);
if(result.getReturnCode().equals(ReturnCode.ERROR){
log.error(result.getErrorCode()+":"+result.getErrorMessage());
} |
Método 'accessIndexFile'
Sistema peticionario pide al sistema remitente (a través del nodo central), el acceso al índice del expediente indicando el token.
...
| title | Ver detalles |
|---|
Signatura
RespuestaAccesoIndiceExpedienteType accessIndexFile(PeticionAccesoIndiceExpedienteType peticionAccesoIndiceExpedienteType).
Parámetros de invocación
...
Nombre
...
Tipo
...
Obligatorio
...
Descripción
...
PeticionAccesoIndiceExpedienteType
...
peticion
...
PeticionType
...
Si
...
Tipo de documento.
...
token
...
StringTokenType
...
Si
...
Tipo de token
Parámetros de respuesta
...
Nombre
...
Tipo
...
Descripción
...
Códigos de error
Los errores de la invocación se encapsulan en RespuestaAccesoIndiceExpedienteType
...
Código
...
Nombre
...
Descripción
...
601
...
PETICION_ERROR
...
Se esperaba objeto petición.
...
602
...
PETICION_NULL
...
Falta petición.
...
603
...
TOKEN_NULL
...
Falta token.
...
604
...
TOKEN_NOT_EXIST
...
El token no existe.
...
606
...
DIR3_ERROR
...
La unidad DIR3 peticionada es errónea.
...
607
...
USER_ERROR
...
Usuario peticionario erróneo para el token.
...
609
...
TOKEN_INVALID
...
El token no es válido para el expediente solicitado.
...
500
...
ERROR_INTERNO
...
Error interno de inside
Ejemplo de invocación
Invocación
| Code Block | ||
|---|---|---|
| ||
RespuestaAccesoIndiceExpedienteType respuesta= cssvClient.accesoIndiceExpedienteType(peticionAccesoIndiceExpedienteType.getPeticion(), peticionAccesoIndiceExpedienteType.getToken().getIdexpEni(),peticionAccesoIndiceExpedienteType.getToken().getCsv(),peticionAccesoIndiceExpedienteType.getToken().getUuid());
log.info(respuesta.getRespuesta().getCodigo()+":"+respuesta.getRespuesta().getDescripcion()); |
Método 'accessDocumentFile'
Sistema peticionario solicita documento de expediente Sistema remitente (sin pasar por Punto Único Justicia, ya se hablan directamente).
...
| title | Ver detalles |
|---|
Signatura
RespuestaAccesoDocumentoExpedienteType accessDocumentFile(PeticionAccesoDocumentoExpedienteType peticionAccesoDocumentoExpediente.
Parámetros de invocación
...
Nombre
...
Tipo
...
Obligatorio
...
Descripción
...
PeticionAccesoDocumentoExpedienteType
...
peticion
...
PeticionType
...
Si
...
Tipo de documento.
...
token
...
StringTokenType
...
Si
...
Tipo de token
...
idDocumento
...
String
...
Si
...
Identificador del documento.
Parámetros de respuesta
...
Nombre
...
Tipo
...
Descripción
...
Códigos de error
Los errores de la invocación se encapsulan en RespuestaAccesoDocumentoExpedienteType
...
Código
...
Nombre
...
Descripción
...
601
...
PETICION_ERROR
...
Se esperaba objeto petición.
...
602
...
PETICION_NULL
...
Falta petición.
...
603
...
TOKEN_NULL
...
Falta token.
...
604
...
TOKEN_NOT_EXIST
...
El token no existe.
...
606
...
DIR3_ERROR
...
La unidad DIR3 peticionada es errónea.
...
607
...
USER_ERROR
...
Usuario peticionario erróneo para el token.
...
609
...
TOKEN_INVALID
...
El token no es válido para el expediente solicitado.
...
500
...
ERROR_INTERNO
...
Error interno de inside
Ejemplo de invocación
Invocación
| Code Block | ||
|---|---|---|
| ||
RespuestaAccesoDocumentoExpedienteType respuesta= cssvClient.accesoDocumentoExpediente(peticionAccesoDocumentoExpediente.getPeticion(),peticionAccesoDocumentoExpediente.getIdDocumento(),
peticionAccesoDocumentoExpediente.getToken().getIndexEni(),peticionAccesoDocumentoExpediente.getToken().getCsv(),peticionAccesoDocumentoExpediente.getToken().getUuid());log.error(respuesta.getRespuesta().getCodigo()+":"+respuesta.getRespuesta().getDescripcion()); |
Servicio CSVConsumerService
A continuación se muestran todos los métodos referentes a la consulta de documentos a través de CSVBroker.
Método 'getDocument'
Permite descargar un documento de cualquier administración dado un csv y un dir3
...
| title | Ver detalles |
|---|
Signatura
ResultGetDocument getDocument(ParamGetDocument paramGetDocument)
Parámetros de invocación
...
Nombre
...
Tipo
...
Obligatorio
...
Descripción
...
ParamGetDocument
...
csv
...
String
...
Si
...
Código CSV
...
dir3
...
String
...
No
...
Organismo que puede estar asociado al CSV
Parámetros de respuesta
...
Nombre
...
Tipo
...
Descripción
...
csvBrokerDocument
...
...
Estructura de datos que contiene los datos obtenidos del documento o bien la lista de organismos que pueden contener al organismo asociado.
Códigos de error
Los errores de la invocación se encapsulan en ResultGetDocument
...
Código
...
Nombre
...
Descripción
...
1505
...
ERROR_GENERAL_CSV_BROKER
...
Error genérico al invocar a CSVBroker
...
1506
...
ERROR_CSV_BROKER_NOT_FOUND
...
No se ha encontrado el CSV
...
1507
...
ERROR_CSV_BROKER_ENDPOINT_ERROR
...
Endpoint de CSVBroker no encontrado
...
1508
...
ERROR_CSV_BROKER_WAIT
...
El documento no puede recuperarse, pero puede consultarse de nuevo pasado un tiempo
Ejemplo de invocación
Invocación
...
| language | java |
|---|
...
Servicios CSVQueryDocumentService, CSVQueryDocumentWSService y CSVQueryDocumentCertificateService
...