Servicio AdministrativeFileServiceRest

A continuación se muestran todos los métodos referentes a la administración de expedientes.

Uso obligatorio del parámetro X-ApplicationId

Además de los parámetros específicos que se deben incluir en cada método, es imprescindible que se indique el parámetro X-ApplicationId en la cabecera de la petición.

Este parámetro permite identificar la aplicación que realiza la invocación y validar sus permisos en PAU. Para más detalles, se recomienda revisar los ejemplos de invocación disponibles.

Métodos para la gestión de expedientes

Método 'organizeAdminFile'

El método permite reordenar los documentos contenidos en un expediente. Permite tanto mover documentos entre carpetas y modificar el orden (num_order) en el que se encuentran.

El método se ejecutará de forma asíncrona. Si no hay problemas de comunicación, el método devolverá OK, y posteriormente se enviará un evento de SGA con código de evento ‘organizeAdminFile’, donde se indicará el resultado de la ordenación con los posibles errores que hayan surgido.

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descripción

Nombre	Tipo	Obligatorio	Descripción
Parámetros organizeAdminFile
csv	String	Si	Código CSV del expediente a reordenar
sortDocumentInfoList	SortDocumentInfo[]	Si	Listado de “movimientos” a realizar

Objeto SortDocumentInfo

Nombre	Tipo	Obligatorio	Descripción

Nombre	Tipo	Obligatorio	Descripción
Campos objeto SortDocumentInfo
csv	String	Si	Código CSV del documento a ordenar
currentIndex	int	Si	Nuevo documentNumOrder que tendrá el documento indicado dentro de la carpeta/raíz del expediente.
newFolder	String	Si	Carpeta “destino” a la que se desea mover el documento. Si no se va a mover el documento, este campo será igual a oldFolderId. Para indicar la raíz del expediente, este campo será “####”.
oldFolder	String	Si	Carpeta “origen” en la que se encuentra el documento. Para indicar la raíz del expediente, este campo será “####”.

Parámetros de respuesta

Nombre	Tipo	Descripción

Nombre	Tipo	Descripción
Resultado organizeAdminFile
result	String	“OK” si la llamada es correcta y “KO” si no. Los errores internos se devolverán en el evento de SGA.
errors	Error []	Listado de errores que se han producido durante la operación. Los errores internos se devolverán en el evento de SGA.

Códigos de error

Los errores internos serán encapsulados en el evento de notificación de SGA.

Código	Nombre	Descripción

Código	Nombre	Descripción
101	ERROR_CONEXION_PAPIRO	Error de conexión con documentum
131	ERROR_GENERICO_PAPIRO	El documentos que se pretende recuperar no existe
801	GENERIC_ERROR	Error genérico procesando la petición.
1027	ERROR_NOTEXIST_DOCINFOLDER	No existe el documento en el expediente indicado
1028	ERROR_NOTEXIST_FOLDERINADMINFILE	No existe la carpeta en el expediente indicado

Ejemplo de invocación y respuesta

Invocación

curl --location 'url_entorno/ccsv_core/rest/organizeAdminFile' \
--header 'X-ApplicationId: CCSV' \
--header 'Content-Type: application/json' \
--data '{
	"csv": "CSVAU79FYH5IK1T0CCSV",
	"sortDocumentInfoList": [
		{
			"csv": "CSVEF1NJBN5IG1D0CCSV",
			"currentIndex": "2",
			"newFolder": "####",
			"oldFolder": "####"
		},
		{
			"csv": "CSVMI3VIAT0IH190CCSV",
			"currentIndex": "0",
			"newFolder": "0906fca38c6c479d",
			"oldFolder": "####"
		}
	]
}'

Respuesta

{
    "errors": null,
    "result": "OK"
}

Método 'getAdminFileLevel'

El método permite recuperar el contenido de un expediente o una carpeta. Únicamente se recuperará “el primer nivel” de dicho directorio, es decir, si se recupera un expediente no recuperará el contenido de las carpetas que contenga.

Este método se podrá utilizar para recuperar contenido de carpetas de expedientes grandes sin la necesidad de cargar todos los documentos y subcarpetas innecesarios.

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descripción

Nombre	Tipo	Obligatorio	Descripción
Parámetros organizeAdminFile
csv	String	Si*	Código CSV del expediente a recuperar (*rellenar este campo o el id)
id	String	Si*	Id de documentum del expediente O CARPETA a recuperar (*rellenar este campo o el csv)

Parámetros de respuesta

Nombre	Tipo	Descripción

Nombre	Tipo	Descripción
Resultado getAdminFileLevel
administrativeFileDocumentList	AdministrativeFileDocument[]	Listado de documentos de la carpeta/expediente
administrativeFileFolderList	AdministrativeFileFolder[]	Listado de carpetas de la carpeta/expediente
errors	Error []	Listado de errores que se han producido durante la operación.

Objeto AdministrativeFileDocument

Nombre	Tipo	Descripción

Nombre	Tipo	Descripción
AdministrativeFileDocument
id	String	ID de documentum del documento
csv	String	CSV del documento
name	String	Nombre del documento
description	String	Descripción del documento
creationDate	String	Fecha de creación del documento
objectType	String	Tipo de objeto de documentum (normalmente dga_paega_doc_dea)
documentType	String	Tipo de documento
procedureCode	String	Código del procedimiento
procedureName	String	Nombre del procedimiento
extension	String	Extensión del documento (pej. ‘pdf’)
numOrder	String	Índice de ordenación del documento respecto al expediente/carpeta indicado en la llamada

Objeto AdministrativeFileFolder

Nombre	Tipo	Descripción

Nombre	Tipo	Descripción
AdministrativeFileDocument
id	String	ID de documentum de la carpeta
code	String	Código de la carpeta
name	String	Nombre de la carpeta
creationDate	String	Fecha de creación de la carpeta
numOrder	String	Índice de ordenación de la carpeta respecto al expediente/carpeta indicado en la llamada

Códigos de error

Código	Nombre	Descripción

Código	Nombre	Descripción
101	ERROR_CONEXION_PAPIRO	Error de conexión con documentum
120	ERROR_ID_NOVALIDO_PAPIRO	Error id de documentum no existe
131	ERROR_GENERICO_PAPIRO	Error genérido de documentum
801	GENERIC_ERROR	Error genérico procesando la petición.

Ejemplo de invocación y respuesta

Invocación

curl --location 'url_entorno/ccsv_core/rest/getAdminFileLevel' \
--header 'X-ApplicationId: CCSV' \
--header 'Content-Type: application/json' \
--data '{
	"csv": "CSVAU79FYH5IK1T0CCSV"
}'

Respuesta

{
    {
   "administrativeFileDocumentList" : [
      {
         "id" : "0906fca38c38bc36",
         "csv" : "CSV7S0LMCR8IB1X0CCSV",
         "name" : "CCSV IIT file",
         "description" : "Documento de pruebas IT",
         "creationDate" : "11/02/2025 9:39:49",
         "objectType" : "dga_paega_doc_dea",
         "documentType" : "INSTRUCCION",
         "procedureCode" : "830",
         "procedureName" : "Solicitud de información previa sobre el valor de bienes inmuebles objeto de adquisición o transmisión",
         "extension" : "pdf",
         "numOrder" : "0"
      },
      {
         "id" : "0906fca38c38bc81",
         "csv" : "CSVU32RMLJ7IX190CCSV",
         "name" : "CCSV IIT file",
         "description" : "Documento de pruebas IT",
         "creationDate" : "11/02/2025 9:42:07",
         "objectType" : "dga_paega_doc_dea",
         "documentType" : "INSTRUCCION",
         "procedureCode" : "830",
         "procedureName" : "Solicitud de información previa sobre el valor de bienes inmuebles objeto de adquisición o transmisión",
         "extension" : "docx",
         "numOrder" : "2"
      },
      {
         "id" : "0906fca38c38bf30",
         "csv" : "CSV7R4LFNW8H41D0CCSV",
         "name" : "CCSV IIT file",
         "description" : "Documento de pruebas IT",
         "creationDate" : "11/02/2025 9:39:47",
         "objectType" : "dga_paega_doc_dea",
         "documentType" : "INSTRUCCION",
         "procedureCode" : "830",
         "procedureName" : "Solicitud de información previa sobre el valor de bienes inmuebles objeto de adquisición o transmisión",
         "extension" : "docx",
         "numOrder" : "1"
      },
      {
         "id" : "0906fca38c38c904",
         "csv" : "CSVMI3VIAT0IH190CCSV",
         "name" : "CCSV IIT file",
         "description" : "Documento de pruebas IT",
         "creationDate" : "11/02/2025 11:22:33",
         "objectType" : "dga_paega_doc_dea",
         "documentType" : "INSTRUCCION",
         "procedureCode" : "830",
         "procedureName" : "Solicitud de información previa sobre el valor de bienes inmuebles objeto de adquisición o transmisión",
         "extension" : "docx",
         "numOrder" : "3"
      }
   ],
   "administrativeFileFolderList" : [
      {
         "id" : "0906fca38c38c979",
         "code" : "JUNIT_TEST",
         "name" : "JUNIT_TEST",
         "creationDate" : "11/02/2025 11:24:10",
         "numOrder" : "0"
      },
      {
         "id" : "0906fca38c6c479d",
         "code" : "CARPETACODE",
         "name" : "CARPETANAME",
         "creationDate" : "22/07/2025 11:08:32",
         "numOrder" : "0"
      },
      {
         "id" : "0906fca38c6c479f",
         "code" : "CARPETACODE2",
         "name" : "CARPETANAME2",
         "creationDate" : "22/07/2025 11:09:04",
         "numOrder" : "0"
      }
   ]
}
}

Método 'regenerateIndex'

El método regenera el indice del expediente, es necesario que el mismo se encuentre en la tabla de regeneración de expedientes para poder ser generado, de lo contrario devolverá error en la tarea asincrona.

El método se ejecutará de forma asíncrona. Si no hay problemas de comunicación, el método devolverá OK, y posteriormente se enviará un evento de SGA con código de evento ‘resultRegenerateIndex’, donde se indicará el resultado de la ordenación con los posibles errores que hayan surgido. El metodo devolvera KO si, al menos uno de los dos, el CSV o el ID del expediente no ha sido especificado en la llamada.

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descripción

Nombre	Tipo	Obligatorio	Descripción
Parámetros regAdminFileIndex
csv	String	Si, en caso de no especificar el ID	Código CSV del expediente a reordenar
id	String	Si, en caso de no especificar el CSV	ID del expediente en documentum
includeAdminFile	boolean	No	Indica si se desea recuperar el objeto expediente con el índice regenerado
attachIndexSignature	boolean	No	Indica si se desea recuperar la firma asociada al índice.

Parámetros de respuesta

Nombre	Tipo	Descripción

Nombre	Tipo	Descripción
Resultado regAdminFileIndex
result	String	“OK” si la llamada es correcta y “KO” si no. Los errores internos se devolverán en el evento de SGA.
errors	String[]	Listado de errores que se han producido durante la operación. Los errores internos se devolverán en el evento de SGA.

Códigos de error

Los errores internos serán encapsulados en el evento de notificación de SGA.

Descripción

Descripción
Error de conexión con documentum
El documentos que se pretende recuperar no existe
Error genérico procesando la petición.
El expediente: ID no esta en la tabla de regeneración de indices.

Ejemplo de invocación y respuesta

Invocación

curl --location 'url_entorno/ccsv_core/rest/regenerateIndex' \
--header 'X-ApplicationId: CCSV' \
--header 'Content-Type: application/json' \
--data '{
	"csv": "CSVAU79FYH5IK1T0CCSV",
    "includeAdminFile": "true"
}'

Respuesta

{
    "status": "OK"
}

ANEXOS

Objetos comunes

A continuación se detallas aquellos objetos o tipos de datos que se utilizan en más de un método.

Objeto 'Error'

Nombre	Tipo	Descripción

Nombre	Tipo	Descripción
errorCode	int	El código de error
errorMessage	String	Mensaje de error
exception	String	Excepción ocurrida

Servicios para la gestión de expedientes (REST)

Servicio AdministrativeFileServiceRest

Métodos para la gestión de expedientes

Método 'organizeAdminFile'

Invocación

Respuesta

Método 'getAdminFileLevel'

Invocación

Respuesta

Método 'regenerateIndex'

Invocación

Respuesta

ANEXOS

Objetos comunes

Objeto 'Error'