White Label Admin - Get organization jobs

White label admin only API to get the list of all jobs for a organization.

GET /api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}/jobs

Try it

White Label Admin - Get organization jobs

cURL

curl --request GET \
  --url https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}/jobs \
  --header 'x-api-key: <api-key>'

200

{
  "success": true,
  "jobs": [
    {
      "id": 123,
      "category": "<string>",
      "categoryKey": "<string>",
      "key": "<string>",
      "created": "2023-11-07T05:31:56Z",
      "jobNotificationUids": [
        123
      ],
      "started": "2023-11-07T05:31:56Z",
      "finished": "2023-11-07T05:31:56Z",
      "finishedSuccessful": true,
      "additionalInfo": "<string>",
      "computeTime": 123,
      "createdByUser": {
        "id": 123,
        "name": "<string>",
        "username": "<string>",
        "photo": "<string>"
      },
      "categoryCount": 123,
      "metadata": {}
    }
  ],
  "totalJobCount": 123,
  "error": "<string>"
}

Authorizations

x-api-key · string · header · required

Path Parameters

organizationId · integer · required

Organization ID

innerOrganizationId · integer · required

Organization ID within the context of a white label

Query Parameters

limit · integer

Maximum number of results

offset · integer

Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.

Response

200 - application/json

OK

success · boolean · required

Whether the operation succeeded

jobs · object[] · required

Active jobs

Show child attributes

jobs. id · integer · required

Job id, use this to refer back to the job. The web socket API also uses this ID.

jobs. category · string · required

User-friendly category (e.g. "Training model")

jobs. categoryKey · string · required

Machine-readable category (e.g. "learn-train-studio-wrapper")

jobs. key · string · required

External job identifier, this can be used to categorize jobs, and recover job status. E.g. set this to 'keras-192' for a Keras learning block with ID 192. When a user refreshes the page you can check whether a job is active for this ID and re-attach.

jobs. created · string<date-time> · required

When the job was created.

jobs. jobNotificationUids · integer[] · required

The IDs of users who should be notified when a job is finished.

jobs. started · string<date-time>

When the job was started.

jobs. finished · string<date-time>

When the job was finished.

jobs. finishedSuccessful · boolean

Whether the job finished successfully.

jobs. additionalInfo · string

Additional metadata associated with this job.

jobs. computeTime · number

Job duration time in seconds from start to finished, measured by k8s job watcher.

jobs. createdByUser · object

The user who started this job.

Show child attributes

jobs.createdByUser. id · integer · required

jobs.createdByUser. name · string · required

jobs.createdByUser. username · string · required

jobs.createdByUser. photo · string

jobs. categoryCount · integer

Some job categories keep a counter on the job number, e.g. in synthetic data, so we know what the 1st, 2nd etc. job was in the UI.

jobs. metadata · object

Structured job metadata

totalJobCount · integer · required

error · string

Optional error description (set if 'success' was false)