API för att starta massbearbetning av resurser

En POST-metod som initierar massbearbetning av resurser för en angiven sökväg. Detta API stöder både JCR-baserad och databasbaserad bearbetning av resurser. Det startar ett asynkront jobb som bearbetar alla resurser under den angivna sökvägen och dess undersökvägar. Vid start returnerar API:t ett unikt processingID, som kan användas för att spåra jobbstatusen.

Begär URL

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

Begär parametrar

Filtrera objektfält

Exempel på begäran

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

Svarsvärden

processingId att avfråga för att få status för asynkront jobb.

{
  "processingId": "akjhdfalkj1132"
}

Svarskoder

Kontrollera jobbstatus

En GET-metod som hämtar aktuell status för ett resurshanteringsjobb som har startats tidigare.

Begär URL

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

Begär parametrar

Exempel på svar

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

Svarskoder

Visa jobbloggar

En GET-metod som hämtar loggar för ett givet jobb-ID. Detta API hämtar loggarna för resursbearbetningsjobbet. Bearbetnings-ID är obligatoriskt. API:t innehåller parametrar för offset och begränsning samt en anpassningsstrategi.

Begär URL

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

Begär parametrar

Exempel på svar

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

Svarskoder

Hämta jobbloggar

En GET-metod som hämtar loggfilen för ett visst jobb som en ZIP-fil.

Begär URL

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

Begär parametrar

Exempel på svar

{
  "logFilePaths": [
    "string"
  ]
}

Svarskoder

Avbryt jobb

Ett POST-API som avbryter en pågående begäran om gruppbearbetning av resurser. Om jobbet inte hittas returneras ett fel.

Begär URL

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

Begär parametrar

Svarskoder

Återuppta jobb

Ett POST-API som startar om en tidigare avbruten eller misslyckad gruppresursbearbetningsbegäran. Bearbetningen fortsätter från den senaste kontrollpunkten. Om jobbet inte hittas eller körs returnerar API:t ett fel.

Begär URL

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

Begär parametrar

Svarskoder

Visa jobbhistorik

Ett GET-API som returnerar de sista N-körningarna av tillgångarnas efterbearbetning.

Begär URL

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

Begär parametrar

Ingen. Denna GET-begäran hämtar jobbhistorik utan att indataparametrar behövs.

Exempel på svar

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