Create Xlsx
curl --request POST \
--url https://app.specurate.com/api/v1/workspaces/{workspaceId}/report-generations/xlsx \
--header 'Content-Type: application/json' \
--data '
{
"projectId": "<string>",
"scope": {
"mode": "explicit",
"slotIds": [
"<string>"
]
},
"format": "product_table",
"columns": [
{
"key": "<string>",
"label": "<string>"
}
],
"options": {
"versionLabel": "<string>",
"rowPerArea": true,
"includeUnallocated": true
},
"sort": {
"key": "system:reference_number",
"direction": "asc"
},
"locale": "en"
}
'import requests
url = "https://app.specurate.com/api/v1/workspaces/{workspaceId}/report-generations/xlsx"
payload = {
"projectId": "<string>",
"scope": {
"mode": "explicit",
"slotIds": ["<string>"]
},
"format": "product_table",
"columns": [
{
"key": "<string>",
"label": "<string>"
}
],
"options": {
"versionLabel": "<string>",
"rowPerArea": True,
"includeUnallocated": True
},
"sort": {
"key": "system:reference_number",
"direction": "asc"
},
"locale": "en"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
projectId: '<string>',
scope: {mode: 'explicit', slotIds: ['<string>']},
format: 'product_table',
columns: [{key: '<string>', label: '<string>'}],
options: {versionLabel: '<string>', rowPerArea: true, includeUnallocated: true},
sort: {key: 'system:reference_number', direction: 'asc'},
locale: 'en'
})
};
fetch('https://app.specurate.com/api/v1/workspaces/{workspaceId}/report-generations/xlsx', 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://app.specurate.com/api/v1/workspaces/{workspaceId}/report-generations/xlsx",
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([
'projectId' => '<string>',
'scope' => [
'mode' => 'explicit',
'slotIds' => [
'<string>'
]
],
'format' => 'product_table',
'columns' => [
[
'key' => '<string>',
'label' => '<string>'
]
],
'options' => [
'versionLabel' => '<string>',
'rowPerArea' => true,
'includeUnallocated' => true
],
'sort' => [
'key' => 'system:reference_number',
'direction' => 'asc'
],
'locale' => 'en'
]),
CURLOPT_HTTPHEADER => [
"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://app.specurate.com/api/v1/workspaces/{workspaceId}/report-generations/xlsx"
payload := strings.NewReader("{\n \"projectId\": \"<string>\",\n \"scope\": {\n \"mode\": \"explicit\",\n \"slotIds\": [\n \"<string>\"\n ]\n },\n \"format\": \"product_table\",\n \"columns\": [\n {\n \"key\": \"<string>\",\n \"label\": \"<string>\"\n }\n ],\n \"options\": {\n \"versionLabel\": \"<string>\",\n \"rowPerArea\": true,\n \"includeUnallocated\": true\n },\n \"sort\": {\n \"key\": \"system:reference_number\",\n \"direction\": \"asc\"\n },\n \"locale\": \"en\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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://app.specurate.com/api/v1/workspaces/{workspaceId}/report-generations/xlsx")
.header("Content-Type", "application/json")
.body("{\n \"projectId\": \"<string>\",\n \"scope\": {\n \"mode\": \"explicit\",\n \"slotIds\": [\n \"<string>\"\n ]\n },\n \"format\": \"product_table\",\n \"columns\": [\n {\n \"key\": \"<string>\",\n \"label\": \"<string>\"\n }\n ],\n \"options\": {\n \"versionLabel\": \"<string>\",\n \"rowPerArea\": true,\n \"includeUnallocated\": true\n },\n \"sort\": {\n \"key\": \"system:reference_number\",\n \"direction\": \"asc\"\n },\n \"locale\": \"en\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.specurate.com/api/v1/workspaces/{workspaceId}/report-generations/xlsx")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"projectId\": \"<string>\",\n \"scope\": {\n \"mode\": \"explicit\",\n \"slotIds\": [\n \"<string>\"\n ]\n },\n \"format\": \"product_table\",\n \"columns\": [\n {\n \"key\": \"<string>\",\n \"label\": \"<string>\"\n }\n ],\n \"options\": {\n \"versionLabel\": \"<string>\",\n \"rowPerArea\": true,\n \"includeUnallocated\": true\n },\n \"sort\": {\n \"key\": \"system:reference_number\",\n \"direction\": \"asc\"\n },\n \"locale\": \"en\"\n}"
response = http.request(request)
puts response.read_body{}Report Generations
Create Xlsx
POST
/
v1
/
workspaces
/
{workspaceId}
/
report-generations
/
xlsx
Create Xlsx
curl --request POST \
--url https://app.specurate.com/api/v1/workspaces/{workspaceId}/report-generations/xlsx \
--header 'Content-Type: application/json' \
--data '
{
"projectId": "<string>",
"scope": {
"mode": "explicit",
"slotIds": [
"<string>"
]
},
"format": "product_table",
"columns": [
{
"key": "<string>",
"label": "<string>"
}
],
"options": {
"versionLabel": "<string>",
"rowPerArea": true,
"includeUnallocated": true
},
"sort": {
"key": "system:reference_number",
"direction": "asc"
},
"locale": "en"
}
'import requests
url = "https://app.specurate.com/api/v1/workspaces/{workspaceId}/report-generations/xlsx"
payload = {
"projectId": "<string>",
"scope": {
"mode": "explicit",
"slotIds": ["<string>"]
},
"format": "product_table",
"columns": [
{
"key": "<string>",
"label": "<string>"
}
],
"options": {
"versionLabel": "<string>",
"rowPerArea": True,
"includeUnallocated": True
},
"sort": {
"key": "system:reference_number",
"direction": "asc"
},
"locale": "en"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
projectId: '<string>',
scope: {mode: 'explicit', slotIds: ['<string>']},
format: 'product_table',
columns: [{key: '<string>', label: '<string>'}],
options: {versionLabel: '<string>', rowPerArea: true, includeUnallocated: true},
sort: {key: 'system:reference_number', direction: 'asc'},
locale: 'en'
})
};
fetch('https://app.specurate.com/api/v1/workspaces/{workspaceId}/report-generations/xlsx', 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://app.specurate.com/api/v1/workspaces/{workspaceId}/report-generations/xlsx",
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([
'projectId' => '<string>',
'scope' => [
'mode' => 'explicit',
'slotIds' => [
'<string>'
]
],
'format' => 'product_table',
'columns' => [
[
'key' => '<string>',
'label' => '<string>'
]
],
'options' => [
'versionLabel' => '<string>',
'rowPerArea' => true,
'includeUnallocated' => true
],
'sort' => [
'key' => 'system:reference_number',
'direction' => 'asc'
],
'locale' => 'en'
]),
CURLOPT_HTTPHEADER => [
"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://app.specurate.com/api/v1/workspaces/{workspaceId}/report-generations/xlsx"
payload := strings.NewReader("{\n \"projectId\": \"<string>\",\n \"scope\": {\n \"mode\": \"explicit\",\n \"slotIds\": [\n \"<string>\"\n ]\n },\n \"format\": \"product_table\",\n \"columns\": [\n {\n \"key\": \"<string>\",\n \"label\": \"<string>\"\n }\n ],\n \"options\": {\n \"versionLabel\": \"<string>\",\n \"rowPerArea\": true,\n \"includeUnallocated\": true\n },\n \"sort\": {\n \"key\": \"system:reference_number\",\n \"direction\": \"asc\"\n },\n \"locale\": \"en\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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://app.specurate.com/api/v1/workspaces/{workspaceId}/report-generations/xlsx")
.header("Content-Type", "application/json")
.body("{\n \"projectId\": \"<string>\",\n \"scope\": {\n \"mode\": \"explicit\",\n \"slotIds\": [\n \"<string>\"\n ]\n },\n \"format\": \"product_table\",\n \"columns\": [\n {\n \"key\": \"<string>\",\n \"label\": \"<string>\"\n }\n ],\n \"options\": {\n \"versionLabel\": \"<string>\",\n \"rowPerArea\": true,\n \"includeUnallocated\": true\n },\n \"sort\": {\n \"key\": \"system:reference_number\",\n \"direction\": \"asc\"\n },\n \"locale\": \"en\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.specurate.com/api/v1/workspaces/{workspaceId}/report-generations/xlsx")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"projectId\": \"<string>\",\n \"scope\": {\n \"mode\": \"explicit\",\n \"slotIds\": [\n \"<string>\"\n ]\n },\n \"format\": \"product_table\",\n \"columns\": [\n {\n \"key\": \"<string>\",\n \"label\": \"<string>\"\n }\n ],\n \"options\": {\n \"versionLabel\": \"<string>\",\n \"rowPerArea\": true,\n \"includeUnallocated\": true\n },\n \"sort\": {\n \"key\": \"system:reference_number\",\n \"direction\": \"asc\"\n },\n \"locale\": \"en\"\n}"
response = http.request(request)
puts response.read_body{}Body
application/json
- Option 1
- Option 2
- Option 3
Response
201 - application/json
The response is of type object.
⌘I