Jobs

Returns the status of a specific job.

get

Authorizations

api-key

api-keystringRequired

API Key

Path parameters

uidstringRequired

Header parameters

organization-idstringRequired

Organization ID

Responses

200Success

application/json

appstringRequired

servicestringRequired

warningsobject[]Required

instanceIdstringRequired

requestIdstringRequired

get

/v1/bi/jobs/{uid}

HTTPcURLJavaScriptPython

GET /v1/bi/jobs/{uid} HTTP/1.1
api-key: YOUR_API_KEY
organization-id: text
Accept: */*

200Success

{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "job": {
      "status": "canceled",
      "log": "text",
      "submittedAt": "text",
      "startedAt": "text",
      "outputMimeType": "text",
      "outputFileName": "text",
      "id": "text",
      "downloadUrl": "text"
    }
  }
}

Submits a new request to process a specific data model.

post

Authorizations

api-key

api-keystringRequired

API Key

Header parameters

organization-idstringRequired

Organization ID

Body

application/json

Responses

200Success

application/json

appstringRequired

servicestringRequired

warningsobject[]Required

instanceIdstringRequired

requestIdstringRequired

400

Functional Error

application/json

post

/v1/bi/jobs

HTTPcURLJavaScriptPython

POST /v1/bi/jobs HTTP/1.1
api-key: YOUR_API_KEY
organization-id: text
Content-Type: application/json
Accept: */*
Content-Length: 138

{
  "params": {
    "uid": "text",
    "organizationUid": "text",
    "parameters": [
      {
        "key": "text",
        "value": {}
      }
    ],
    "query": {},
    "lang": "ar",
    "template": "excel-auto"
  }
}

{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "jobId": "text"
  }
}