API om bulkverwerking voor middelen te starten

A POST method that initiates bulkasset processing for a specified path. Deze API ondersteunt zowel op JCR gebaseerde als op database gebaseerde verwerking van middelen. Het begint een asynchrone baan die alle activa onder de bepaalde weg en zijn sub-wegen verwerkt. Na initiatie retourneert de API een unieke processingID, die kan worden gebruikt om de taakstatus bij te houden.

Verzoek URL

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

Parameters van het Verzoek

de objecten van de Filter gebieden

Voorbeeld van het Verzoek

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

waarden van de Reactie

verwerkingsId aan opiniepeiling over om de status van asynchrone baan te krijgen.

{
  "processingId": "akjhdfalkj1132"
}

Codes van de Reactie

Taakstatus controleren

Een GET-methode die de huidige status ophaalt van een eerder begonnen elementverwerkingstaak.

Verzoek URL

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

Parameters van het Verzoek

Voorbeeld van de Reactie

{
  "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 van de Reactie

Taaklogbestanden weergeven

Een GET-methode waarmee logbestanden voor een bepaalde taak-id worden opgehaald. Deze API haalt de logboeken van de elementverwerkingstaak op. De verwerkings-id is verplicht. De API biedt naast verschuivings- en limietparameters ook een eindstrategie.

Verzoek URL

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

Parameters van het Verzoek

Voorbeeld van de Reactie

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

Codes van de Reactie

Taaklogbestanden downloaden

Een GET-methode waarmee het logbestand voor een bepaalde taak wordt gedownload als een ZIP-bestand.

Verzoek URL

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

Parameters van het Verzoek

Voorbeeld van de Reactie

{
  "logFilePaths": [
    "string"
  ]
}

Codes van de Reactie

Taak annuleren

Een POST-API die een aanvraag voor de verwerking van bulkmiddelen annuleert. Als de taak niet wordt gevonden, retourneert de API een fout.

Verzoek URL

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

Parameters van het Verzoek

Codes van de Reactie

Taak hervatten

Een POST-API die een eerder geannuleerde of mislukte aanvraag voor de verwerking van bulkmiddelen opnieuw start. Het hervat verwerking vanaf het laatste controlepunt. Als de taak niet wordt gevonden of momenteel wordt uitgevoerd, retourneert de API een fout.

Verzoek URL

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

Parameters van het Verzoek

Codes van de Reactie

Taakgeschiedenis weergeven

Een GET API die de laatste 'N'-executies van Asset Naprocessing retourneert.

Verzoek URL

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

Parameters van het Verzoek

Geen. Deze GET-aanvraag haalt de taakgeschiedenis op zonder invoerparameters te vereisen.

Voorbeeld van de Reactie

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