API per avviare l’elaborazione in blocco delle risorse

Metodo POST che avvia l'elaborazione in blocco delle risorse per un percorso specificato. Questa API supporta sia l’elaborazione delle risorse basata su JCR che quella basata su database. Avvia un processo asincrono che elabora tutte le risorse sotto il percorso specificato e i relativi percorsi secondari. Al momento dell’avvio, l’API restituisce un processingID univoco che può essere utilizzato per monitorare lo stato del processo.

URL richiesta

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

Parametri richiesta

Filtra campi oggetto

Esempio di richiesta

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

Valori risposta

processingId per il polling e ottenere lo stato del processo asincrono.

{
  "processingId": "akjhdfalkj1132"
}

Codici di risposta

Verifica stato processo

Metodo GET che recupera lo stato corrente di un processo di elaborazione di risorse avviato in precedenza.

URL richiesta

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

Parametri richiesta

Esempio di risposta

{
  "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
}

Codici di risposta

Visualizza registri di processo

Un metodo GET che recupera i registri per un determinato ID processo. Questa API recupera i registri del processo di elaborazione delle risorse. L’ID elaborazione è obbligatorio. L’API fornisce parametri di offset e limite, nonché una strategia di code.

URL richiesta

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

Parametri richiesta

Esempio di risposta

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

Codici di risposta

Scarica registri di processo

Un metodo GET che scarica il file di registro per un determinato processo come file ZIP.

URL richiesta

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

Parametri richiesta

Esempio di risposta

{
  "logFilePaths": [
    "string"
  ]
}

Codici di risposta

Annulla processo

API POST che annulla una richiesta di elaborazione in blocco di risorse in corso. Se il processo non viene trovato, l’API restituisce un errore.

URL richiesta

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

Parametri richiesta

Codici di risposta

Riprendi processo

API POST che riavvia una richiesta di elaborazione in blocco di risorse precedentemente annullata o non riuscita. Riprende l’elaborazione dall’ultimo punto di controllo. Se il processo non viene trovato o è attualmente in esecuzione, l’API restituisce un errore.

URL richiesta

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

Parametri richiesta

Codici di risposta

Visualizza cronologia processo

Un’API GET che restituisce le ultime "N" esecuzioni del post-elaborazione delle risorse.

URL richiesta

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

Parametri richiesta

Nessuno. Questa richiesta GET recupera la cronologia dei processi senza richiedere parametri di input.

Esempio di risposta

{
  "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
    }
  ]
}