curl --request POST \
--url https://api.example.com/api/v1/ops/export-schedules \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"columns": [
"code"
],
"filters": {},
"resource": "order",
"format": "CSV",
"scheduledAt": "2023-11-07T05:31:56Z",
"scopeType": "COMPANY",
"fileNamePrefix": "orders"
}
'import requests
url = "https://api.example.com/api/v1/ops/export-schedules"
payload = {
"columns": ["code"],
"filters": {},
"resource": "order",
"format": "CSV",
"scheduledAt": "2023-11-07T05:31:56Z",
"scopeType": "COMPANY",
"fileNamePrefix": "orders"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
columns: ['code'],
filters: {},
resource: 'order',
format: 'CSV',
scheduledAt: '2023-11-07T05:31:56Z',
scopeType: 'COMPANY',
fileNamePrefix: 'orders'
})
};
fetch('https://api.example.com/api/v1/ops/export-schedules', 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-schedules",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'columns' => [
'code'
],
'filters' => [
],
'resource' => 'order',
'format' => 'CSV',
'scheduledAt' => '2023-11-07T05:31:56Z',
'scopeType' => 'COMPANY',
'fileNamePrefix' => 'orders'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v1/ops/export-schedules"
payload := strings.NewReader("{\n \"columns\": [\n \"code\"\n ],\n \"filters\": {},\n \"resource\": \"order\",\n \"format\": \"CSV\",\n \"scheduledAt\": \"2023-11-07T05:31:56Z\",\n \"scopeType\": \"COMPANY\",\n \"fileNamePrefix\": \"orders\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/api/v1/ops/export-schedules")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"columns\": [\n \"code\"\n ],\n \"filters\": {},\n \"resource\": \"order\",\n \"format\": \"CSV\",\n \"scheduledAt\": \"2023-11-07T05:31:56Z\",\n \"scopeType\": \"COMPANY\",\n \"fileNamePrefix\": \"orders\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/ops/export-schedules")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"columns\": [\n \"code\"\n ],\n \"filters\": {},\n \"resource\": \"order\",\n \"format\": \"CSV\",\n \"scheduledAt\": \"2023-11-07T05:31:56Z\",\n \"scopeType\": \"COMPANY\",\n \"fileNamePrefix\": \"orders\"\n}"
response = http.request(request)
puts response.read_body{
"exportScheduledId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
"requestedByUserId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3d",
"resource": "order",
"scopeType": "COMPANY",
"format": "CSV",
"columns": [
"code"
],
"filters": {},
"status": "SCHEDULED",
"createdAt": "2023-11-07T05:31:56Z",
"scheduledAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"organizationId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3b",
"companyId": null,
"cooperativeId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3c",
"fileNamePrefix": "orders",
"failureReason": null,
"deletedAt": "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
}Create Export Schedule
Creates a scheduled export.
curl --request POST \
--url https://api.example.com/api/v1/ops/export-schedules \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"columns": [
"code"
],
"filters": {},
"resource": "order",
"format": "CSV",
"scheduledAt": "2023-11-07T05:31:56Z",
"scopeType": "COMPANY",
"fileNamePrefix": "orders"
}
'import requests
url = "https://api.example.com/api/v1/ops/export-schedules"
payload = {
"columns": ["code"],
"filters": {},
"resource": "order",
"format": "CSV",
"scheduledAt": "2023-11-07T05:31:56Z",
"scopeType": "COMPANY",
"fileNamePrefix": "orders"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
columns: ['code'],
filters: {},
resource: 'order',
format: 'CSV',
scheduledAt: '2023-11-07T05:31:56Z',
scopeType: 'COMPANY',
fileNamePrefix: 'orders'
})
};
fetch('https://api.example.com/api/v1/ops/export-schedules', 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-schedules",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'columns' => [
'code'
],
'filters' => [
],
'resource' => 'order',
'format' => 'CSV',
'scheduledAt' => '2023-11-07T05:31:56Z',
'scopeType' => 'COMPANY',
'fileNamePrefix' => 'orders'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v1/ops/export-schedules"
payload := strings.NewReader("{\n \"columns\": [\n \"code\"\n ],\n \"filters\": {},\n \"resource\": \"order\",\n \"format\": \"CSV\",\n \"scheduledAt\": \"2023-11-07T05:31:56Z\",\n \"scopeType\": \"COMPANY\",\n \"fileNamePrefix\": \"orders\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/api/v1/ops/export-schedules")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"columns\": [\n \"code\"\n ],\n \"filters\": {},\n \"resource\": \"order\",\n \"format\": \"CSV\",\n \"scheduledAt\": \"2023-11-07T05:31:56Z\",\n \"scopeType\": \"COMPANY\",\n \"fileNamePrefix\": \"orders\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/ops/export-schedules")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"columns\": [\n \"code\"\n ],\n \"filters\": {},\n \"resource\": \"order\",\n \"format\": \"CSV\",\n \"scheduledAt\": \"2023-11-07T05:31:56Z\",\n \"scopeType\": \"COMPANY\",\n \"fileNamePrefix\": \"orders\"\n}"
response = http.request(request)
puts response.read_body{
"exportScheduledId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
"requestedByUserId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3d",
"resource": "order",
"scopeType": "COMPANY",
"format": "CSV",
"columns": [
"code"
],
"filters": {},
"status": "SCHEDULED",
"createdAt": "2023-11-07T05:31:56Z",
"scheduledAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"organizationId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3b",
"companyId": null,
"cooperativeId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3c",
"fileNamePrefix": "orders",
"failureReason": null,
"deletedAt": "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.
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.
Body
Create scheduled export payload
Requested export columns
1["code"]
Requested export filters by field
Show child attributes
Show child attributes
Export resource key
"order"
Export file format
CSV, XLSX "CSV"
Export scope type
ORGANIZATION, COMPANY, COOPERATIVE, BKO "COMPANY"
Generated file name prefix
"orders"
Response
Created
Export schedule
Export schedule 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"]
Requested export filters by field
Show child attributes
Show child attributes
Scheduled export status
SCHEDULED, COMPLETED, FAILED, CANCELED "SCHEDULED"
Creation timestamp
Scheduled execution timestamp
Last update timestamp
Scoped organization identifier
"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3b"
Scoped company identifier
null
Scoped cooperative identifier
"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3c"
Generated file name prefix
"orders"
Dispatch failure reason
null
Soft deletion timestamp