curl --request GET \
--url https://api.example.com/api/v1/ops/export-jobs/{exportJobId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.example.com/api/v1/ops/export-jobs/{exportJobId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.example.com/api/v1/ops/export-jobs/{exportJobId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/v1/ops/export-jobs/{exportJobId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v1/ops/export-jobs/{exportJobId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/api/v1/ops/export-jobs/{exportJobId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/ops/export-jobs/{exportJobId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"exportJobId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
"requestedByUserId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3d",
"resource": "order",
"scopeType": "COMPANY",
"format": "CSV",
"columns": [
"code",
"status"
],
"filters": {},
"status": "COMPLETED",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"exportScheduledId": null,
"organizationId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3b",
"companyId": null,
"cooperativeId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3c",
"fileKey": null,
"fileName": null,
"contentType": null,
"sizeBytes": null,
"totalRows": null,
"failureReason": null,
"deletedAt": "2023-11-07T05:31:56Z",
"expiresAt": "2023-11-07T05:31:56Z",
"finishedAt": "2023-11-07T05:31:56Z",
"startedAt": "2023-11-07T05:31:56Z"
}{
"errors": [
{
"message": "required",
"path": "name"
}
],
"message": "Bad Request Error",
"statusCode": 400
}{
"message": "Missing or invalid access token",
"statusCode": 401
}{
"message": "Insufficient permissions",
"statusCode": 403
}{
"message": "Internal Server Error",
"statusCode": 500
}Get Export Job
Returns an export job.
curl --request GET \
--url https://api.example.com/api/v1/ops/export-jobs/{exportJobId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.example.com/api/v1/ops/export-jobs/{exportJobId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.example.com/api/v1/ops/export-jobs/{exportJobId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/v1/ops/export-jobs/{exportJobId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v1/ops/export-jobs/{exportJobId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/api/v1/ops/export-jobs/{exportJobId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/ops/export-jobs/{exportJobId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"exportJobId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
"requestedByUserId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3d",
"resource": "order",
"scopeType": "COMPANY",
"format": "CSV",
"columns": [
"code",
"status"
],
"filters": {},
"status": "COMPLETED",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"exportScheduledId": null,
"organizationId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3b",
"companyId": null,
"cooperativeId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3c",
"fileKey": null,
"fileName": null,
"contentType": null,
"sizeBytes": null,
"totalRows": null,
"failureReason": null,
"deletedAt": "2023-11-07T05:31:56Z",
"expiresAt": "2023-11-07T05:31:56Z",
"finishedAt": "2023-11-07T05:31:56Z",
"startedAt": "2023-11-07T05:31:56Z"
}{
"errors": [
{
"message": "required",
"path": "name"
}
],
"message": "Bad Request Error",
"statusCode": 400
}{
"message": "Missing or invalid access token",
"statusCode": 401
}{
"message": "Insufficient permissions",
"statusCode": 403
}{
"message": "Internal Server Error",
"statusCode": 500
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Export job identifier
"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a"
Query Parameters
Comma-separated list of fields to include in the response. Supports dot notation for nested projection (e.g. id,name,user.email,trips.route.id). Unknown fields are silently dropped.
Response
OK
Export job
Export job identifier
"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a"
Requesting user identifier
"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3d"
Export resource key
"order"
Export scope type
ORGANIZATION, COMPANY, COOPERATIVE, BKO "COMPANY"
Export file format
CSV, XLSX "CSV"
Requested export columns
1["code", "status"]
Requested export filters by field
Show child attributes
Show child attributes
Export job status
PENDING, QUEUED, RUNNING, COMPLETED, FAILED, EXPIRED, CANCELED "COMPLETED"
Originating export schedule identifier
null
Scoped organization identifier
"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3b"
Scoped company identifier
null
Scoped cooperative identifier
"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3c"
Private storage object key
null
Suggested download file name
null
Generated file MIME type
null
Generated file size in bytes
null
Generated row count
null
Failure reason
null