Jobs
Authorizations
Path parameters
uidstringRequired
Header parameters
organization-idstringRequired
Organization ID
Responses
200Success
application/json
get
GET /v1/bi/jobs/{uid} HTTP/1.1
Host:
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"
}
}
}
Authorizations
Header parameters
organization-idstringRequired
Organization ID
Body
Responses
200Success
application/json
400
Functional Error
application/json
post
POST /v1/bi/jobs HTTP/1.1
Host:
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"
}
}
Was this helpful?