API para iniciar el procesamiento masivo de recursos

Un método POST que inicia el procesamiento masivo de recursos para una ruta de acceso especificada. Esta API admite el procesamiento de recursos basado en JCR y en base a datos. Inicia un trabajo asincrónico que procesa todos los recursos de la ruta dada y sus subrutas. Al iniciarse, la API devuelve un ID de procesamiento único, que se puede utilizar para realizar un seguimiento del estado del trabajo.

URL de solicitud

http://<aem-guides-server>:<port-number>/bin/guides/v1/assets/process

Parámetros de solicitud

Filtrar campos de objeto

Ejemplo de solicitud

{
  "path": "/content/dam/status-fetch1",
  "excludedPaths": [
    "content/dam/status-fetch1/excluded-folder"
  ],
  "type": "ASSET_PROCESSING",
  "filter": {
        "fileTypes": ["DITAMAP", "DITATOPIC"],
        "startTime": 1758876933000
        "endTime": 1764932039000
    }
}

Valores de respuesta

processingId para sondear y obtener el estado del trabajo asincrónico.

{
  "processingId": "akjhdfalkj1132"
}

Códigos de respuesta

Comprobar estado del trabajo

Método de GET que recupera el estado actual de un trabajo de procesamiento de recursos iniciado anteriormente.

URL de solicitud

http://<aem-guides-server>:<port-number>/bin/guides/v1/assets/process/status

Parámetros de solicitud

Ejemplo de respuesta

{
  "processingId": "string",
  "path": "string",
  "excludedPaths": ["string"],
  "status": "WAITING",
  "triggeredCount": 0,
  "startedAt": 0,
  "completedAt": 0,
  "hasLogs": true,
  "createdBy": "string",
  "type": "ASSET_PROCESSING",
  "migrationSet": {
    "totalFiles": 0,
    "calculationStatus": "WAITING"
  },
  "eta": {
    "value": 0,
    "unit": "string"
  },
  "comments": "string",
  "restartable": true,
  "resumable": true,
  "cancellable": true
}

Códigos de respuesta

Ver registros de trabajos

Método de GET que recupera los registros de un ID de trabajo determinado. Esta API recupera los registros del trabajo de procesamiento de recursos. El ID de procesamiento es obligatorio. La API proporciona parámetros de desplazamiento y límite, así como una estrategia de seguimiento.

URL de solicitud

http://<aem-guides-server>:<port-number>/bin/guides/v1/assets/process/logs

Parámetros de solicitud

Ejemplo de respuesta

{
  "lines": [
    "string"
  ],
  "limit": 0,
  "offset": 0,
  "hasMore": true
}

Códigos de respuesta

Descargar registros de trabajo

Método de GET que descarga el archivo de registro de un trabajo determinado como ZIP.

URL de solicitud

http://<aem-guides-server>:<port-number>/bin/guides/v1/assets/process/logs/download

Parámetros de solicitud

Ejemplo de respuesta

{
  "logFilePaths": [
    "string"
  ]
}

Códigos de respuesta

Cancelar trabajo

Una API de POST que cancela una solicitud de procesamiento masivo de recursos en curso. Si no se encuentra el trabajo, la API devuelve un error.

URL de solicitud

http://<aem-guides-server>:<port-number>/bin/guides/v1/assets/process/cancel

Parámetros de solicitud

Códigos de respuesta

Reanudar trabajo

Una API de POST que reinicia una solicitud de procesamiento masivo de recursos que se ha cancelado o que ha dado error. Reanuda el procesamiento desde el último punto de comprobación. Si el trabajo no se encuentra o se está ejecutando, la API devuelve un error.

URL de solicitud

http://<aem-guides-server>:<port-number>/bin/guides/v1/assets/process/resume

Parámetros de solicitud

Códigos de respuesta

Ver historial de trabajos

Una API de GET que devuelve las últimas "N" ejecuciones de posprocesamiento de recursos.

URL de solicitud

http://<aem-guides-server>:<port-number>/bin/guides/v1/assets/process/history

Parámetros de solicitud

Ninguna. Esta solicitud de GET recupera el historial de trabajos sin requerir parámetros de entrada.

Ejemplo de respuesta

{
  "executionHistory": [
    {
      "processingId": "165f1de6-68c4-4dcd-9223-2b7242b62306",
      "path": "/content/dam/22858",
      "status": "SUCCESS",
      "triggeredCount": 6,
      "startedAt": 1761291362776,
      "completedAt": 1761291364026,
      "hasLogs": true,
      "createdBy": "user",
      "type": "ASSET_PROCESSING",
      "migrationSet": {
        "totalFiles": 6,
        "calculationStatus": "SUCCESS"
      },
      "eta": {
        "value": 0,
        "unit": "SECONDS"
      },
      "comments": "",
      "filter": {
        "fileTypes": [],
        "filterProcessedAssets": false
      },
      "cancellable": false,
      "resumable": false,
      "restartable": true
    }
  ]
}