API zum Starten der Massenverarbeitung für Assets

Eine POST-Methode, die die Massenverarbeitung von Assets für einen angegebenen Pfad initiiert. Diese API unterstützt sowohl die JCR-basierte als auch die datenbankbasierte Asset-Verarbeitung. Dadurch wird ein asynchroner Auftrag gestartet, der alle Assets unter dem angegebenen Pfad und dessen Unterpfaden verarbeitet. Nach der Initiierung gibt die API eine eindeutige Verarbeitungs-ID zurück, mit der der Auftragsstatus verfolgt werden kann.

URL-Anforderung

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

Anfrageparameter

Objektfelder filtern

Beispiel für eine Anfrage

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

Antwortwerte

processingId , um den Status des asynchronen Auftrags abzurufen.

{
  "processingId": "akjhdfalkj1132"
}

Antwort-Codes

Überprüfen des Auftragsstatus

Eine GET-Methode, die den aktuellen Status eines zuvor gestarteten Asset-Verarbeitungsauftrags abruft.

URL-Anforderung

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

Anfrageparameter

Beispiel für eine Antwort

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

Antwort-Codes

Vorgangslogs anzeigen

Eine GET-Methode, die Protokolle für eine bestimmte Auftrags-ID abruft. Diese API ruft die Protokolle des Asset-Verarbeitungsauftrags ab. Die Verarbeitungs-ID ist obligatorisch. Die API stellt Versatz- und Begrenzungsparameter sowie eine Tailing-Strategie bereit.

URL-Anforderung

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

Anfrageparameter

Beispiel für eine Antwort

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

Antwort-Codes

Vorgangslogs herunterladen

Eine GET-Methode, die die Protokolldatei für einen bestimmten Auftrag als ZIP herunterlädt.

URL-Anforderung

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

Anfrageparameter

Beispiel für eine Antwort

{
  "logFilePaths": [
    "string"
  ]
}

Antwort-Codes

Auftrag abbrechen

Eine POST-API, die eine laufende Massen-Asset-Verarbeitungsanfrage abbricht. Wenn der Auftrag nicht gefunden wird, gibt die API einen Fehler zurück.

URL-Anforderung

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

Anfrageparameter

Antwort-Codes

Vorgang fortsetzen

Eine POST-API, die eine zuvor abgebrochene oder fehlgeschlagene Massen-Asset-Verarbeitungsanfrage neu startet. Die Verarbeitung wird am letzten Checkpoint fortgesetzt. Wenn der Auftrag nicht gefunden wird oder gerade ausgeführt wird, gibt die API einen Fehler zurück.

URL-Anforderung

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

Anfrageparameter

Antwort-Codes

Vorgangsverlauf anzeigen

Eine GET-API, die die letzten N Ausführungen der Asset-Nachbearbeitung zurückgibt.

URL-Anforderung

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

Anfrageparameter

Ohne. Diese GET-Anfrage ruft den Auftragsverlauf ab, ohne dass Eingabeparameter erforderlich sind.

Beispiel für eine Antwort

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