API pour démarrer le traitement en bloc des ressources

Méthode POST qui lance le traitement des ressources en bloc pour un chemin d’accès spécifié. Cette API prend en charge le traitement des ressources basé sur JCR et sur la base de données. Il lance une tâche asynchrone qui traite toutes les ressources du chemin donné et de ses sous-chemins. Lors du lancement, l’API renvoie un ID de traitement unique, qui peut être utilisé pour suivre le statut de la tâche.

URL de la demande

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

Paramètres de requête

Filtrer les champs d’objet

Exemple de requête

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

Valeurs de réponse

processingId à interroger pour obtenir le statut du traitement asynchrone.

{
  "processingId": "akjhdfalkj1132"
}

Codes de réponse

Vérifier le statut du traitement

Une méthode GET qui récupère le statut actuel d’une tâche de traitement des ressources démarrée précédemment.

URL de la demande

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

Paramètres de requête

Exemple de réponse

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

Codes de réponse

Affichage des journaux de tâches

Méthode GET qui récupère les journaux d’un ID de tâche donné. Cette API récupère les journaux de la tâche de traitement des ressources. L’ID de traitement est obligatoire. L’API fournit des paramètres de décalage et de limite, ainsi qu’une stratégie de fin.

URL de la demande

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

Paramètres de requête

Exemple de réponse

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

Codes de réponse

Télécharger les journaux de tâches

Méthode GET qui télécharge le fichier journal d’une tâche donnée au format ZIP.

URL de la demande

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

Paramètres de requête

Exemple de réponse

{
  "logFilePaths": [
    "string"
  ]
}

Codes de réponse

Annuler le traitement

Une API POST qui annule une requête de traitement des ressources en bloc en cours. Si la tâche est introuvable, l’API renvoie une erreur.

URL de la demande

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

Paramètres de requête

Codes de réponse

Reprendre la tâche

Une API POST qui redémarre une requête de traitement des ressources en bloc précédemment annulée ou ayant échoué. Le traitement reprend à partir du dernier point de contrôle. Si la tâche est introuvable ou est en cours d’exécution, l’API renvoie une erreur.

URL de la demande

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

Paramètres de requête

Codes de réponse

Afficher l’historique des tâches

Une API GET qui renvoie les « N » dernières exécutions de post-traitement des ressources.

URL de la demande

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

Paramètres de requête

Aucune. Cette requête GET récupère l’historique des tâches sans nécessiter de paramètres d’entrée.

Exemple de réponse

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