Keepeek - Bulk jobs

This relation targets the collections of bulk jobs available for being run from API. This collection is ephemeral, that means resource lifetime is short (like files or selections resources).

The availableJobs field shows the number of bulk jobs which can be created.

GET /api/dam/bulk-jobs
Content-Type: application/json

{
  "availableJobs": 7,
  "_links": {
    "self": {
      "href": "https://baobab.keepeek.com/api/dam/bulk-jobs?page=1&size=20"
    },
    "curies": [
      {
        "name": "kpk",
        "href": "https://baobab.keepeek.com/api/doc/rels/{rel}",
        "templated": true
      }
    ]
  },
  "totalCount": 0
}

bulk-job

This relation targets the resource representing a bulk job.

Create a bulk job

Send a POST (create) request on the bulk jobs collection: http://baobab.keepeek.com/api/dam/bulk-jobs The request can be either empty, or include a bulk-job representation allowing to define custom duration to override the default value of 30 seconds. The allowed values for job duration are in the range 30-600, ie from 30 seconds to 10 minutes.

If the creation is successful, the API returns a 201 Created status code and the URL of the created bulk-job in the Location header of the response.

POST http://baobab.keepeek.com/api/dam/bulk-jobs
Content-Type: application/json

{
  "duration" : 60
}


HTTP/1.1 201 Created
Location: http://baobab.keepeek.com/api/dam/bulk-jobs/9fa23b4a

4.33.0+. Requires a licence allowing bulk jobs from API.