Skip to main content
POST
/
v1
/
nesting
/
result
/
Request a ReportSource response for a nesting Result
curl --request POST \
  --url https://dev.api.nestapi.com/v1/nesting/result/ \
  --header 'Accept: <accept>' \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "RequestId": "<string>",
  "ResultIdentity": "<string>",
  "ReportSourceRenderingSettings": {
    "NestingRenderSettings": {
      "RenderFormat": "<string>",
      "xDimension": 123,
      "yDimension": 123,
      "BackColorARGB": "<string>",
      "OutlineLineColorARGB": "<string>",
      "PartFillColorARGB": "<string>",
      "AutomaticallyChoosePartFillColor": true
    },
    "RenderPartLabelMode": "<string>",
    "PartLabelHeight": 123,
    "PartPreviewRenderSettings": {
      "RenderFormat": "<string>",
      "xDimension": 123,
      "yDimension": 123,
      "BackColorARGB": "<string>",
      "OutlineLineColorARGB": "<string>",
      "PartFillColorARGB": "<string>",
      "AutomaticallyChoosePartFillColor": true
    }
  }
}
'
import requests

url = "https://dev.api.nestapi.com/v1/nesting/result/"

payload = {
"RequestId": "<string>",
"ResultIdentity": "<string>",
"ReportSourceRenderingSettings": {
"NestingRenderSettings": {
"RenderFormat": "<string>",
"xDimension": 123,
"yDimension": 123,
"BackColorARGB": "<string>",
"OutlineLineColorARGB": "<string>",
"PartFillColorARGB": "<string>",
"AutomaticallyChoosePartFillColor": True
},
"RenderPartLabelMode": "<string>",
"PartLabelHeight": 123,
"PartPreviewRenderSettings": {
"RenderFormat": "<string>",
"xDimension": 123,
"yDimension": 123,
"BackColorARGB": "<string>",
"OutlineLineColorARGB": "<string>",
"PartFillColorARGB": "<string>",
"AutomaticallyChoosePartFillColor": True
}
}
}
headers = {
"Accept": "<accept>",
"Authorization": "<api-key>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {
Accept: '<accept>',
Authorization: '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
RequestId: '<string>',
ResultIdentity: '<string>',
ReportSourceRenderingSettings: {
NestingRenderSettings: {
RenderFormat: '<string>',
xDimension: 123,
yDimension: 123,
BackColorARGB: '<string>',
OutlineLineColorARGB: '<string>',
PartFillColorARGB: '<string>',
AutomaticallyChoosePartFillColor: true
},
RenderPartLabelMode: '<string>',
PartLabelHeight: 123,
PartPreviewRenderSettings: {
RenderFormat: '<string>',
xDimension: 123,
yDimension: 123,
BackColorARGB: '<string>',
OutlineLineColorARGB: '<string>',
PartFillColorARGB: '<string>',
AutomaticallyChoosePartFillColor: true
}
}
})
};

fetch('https://dev.api.nestapi.com/v1/nesting/result/', 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://dev.api.nestapi.com/v1/nesting/result/",
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([
'RequestId' => '<string>',
'ResultIdentity' => '<string>',
'ReportSourceRenderingSettings' => [
'NestingRenderSettings' => [
'RenderFormat' => '<string>',
'xDimension' => 123,
'yDimension' => 123,
'BackColorARGB' => '<string>',
'OutlineLineColorARGB' => '<string>',
'PartFillColorARGB' => '<string>',
'AutomaticallyChoosePartFillColor' => true
],
'RenderPartLabelMode' => '<string>',
'PartLabelHeight' => 123,
'PartPreviewRenderSettings' => [
'RenderFormat' => '<string>',
'xDimension' => 123,
'yDimension' => 123,
'BackColorARGB' => '<string>',
'OutlineLineColorARGB' => '<string>',
'PartFillColorARGB' => '<string>',
'AutomaticallyChoosePartFillColor' => true
]
]
]),
CURLOPT_HTTPHEADER => [
"Accept: <accept>",
"Authorization: <api-key>",
"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://dev.api.nestapi.com/v1/nesting/result/"

payload := strings.NewReader("{\n \"RequestId\": \"<string>\",\n \"ResultIdentity\": \"<string>\",\n \"ReportSourceRenderingSettings\": {\n \"NestingRenderSettings\": {\n \"RenderFormat\": \"<string>\",\n \"xDimension\": 123,\n \"yDimension\": 123,\n \"BackColorARGB\": \"<string>\",\n \"OutlineLineColorARGB\": \"<string>\",\n \"PartFillColorARGB\": \"<string>\",\n \"AutomaticallyChoosePartFillColor\": true\n },\n \"RenderPartLabelMode\": \"<string>\",\n \"PartLabelHeight\": 123,\n \"PartPreviewRenderSettings\": {\n \"RenderFormat\": \"<string>\",\n \"xDimension\": 123,\n \"yDimension\": 123,\n \"BackColorARGB\": \"<string>\",\n \"OutlineLineColorARGB\": \"<string>\",\n \"PartFillColorARGB\": \"<string>\",\n \"AutomaticallyChoosePartFillColor\": true\n }\n }\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Accept", "<accept>")
req.Header.Add("Authorization", "<api-key>")
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://dev.api.nestapi.com/v1/nesting/result/")
.header("Accept", "<accept>")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"RequestId\": \"<string>\",\n \"ResultIdentity\": \"<string>\",\n \"ReportSourceRenderingSettings\": {\n \"NestingRenderSettings\": {\n \"RenderFormat\": \"<string>\",\n \"xDimension\": 123,\n \"yDimension\": 123,\n \"BackColorARGB\": \"<string>\",\n \"OutlineLineColorARGB\": \"<string>\",\n \"PartFillColorARGB\": \"<string>\",\n \"AutomaticallyChoosePartFillColor\": true\n },\n \"RenderPartLabelMode\": \"<string>\",\n \"PartLabelHeight\": 123,\n \"PartPreviewRenderSettings\": {\n \"RenderFormat\": \"<string>\",\n \"xDimension\": 123,\n \"yDimension\": 123,\n \"BackColorARGB\": \"<string>\",\n \"OutlineLineColorARGB\": \"<string>\",\n \"PartFillColorARGB\": \"<string>\",\n \"AutomaticallyChoosePartFillColor\": true\n }\n }\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://dev.api.nestapi.com/v1/nesting/result/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Accept"] = '<accept>'
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"RequestId\": \"<string>\",\n \"ResultIdentity\": \"<string>\",\n \"ReportSourceRenderingSettings\": {\n \"NestingRenderSettings\": {\n \"RenderFormat\": \"<string>\",\n \"xDimension\": 123,\n \"yDimension\": 123,\n \"BackColorARGB\": \"<string>\",\n \"OutlineLineColorARGB\": \"<string>\",\n \"PartFillColorARGB\": \"<string>\",\n \"AutomaticallyChoosePartFillColor\": true\n },\n \"RenderPartLabelMode\": \"<string>\",\n \"PartLabelHeight\": 123,\n \"PartPreviewRenderSettings\": {\n \"RenderFormat\": \"<string>\",\n \"xDimension\": 123,\n \"yDimension\": 123,\n \"BackColorARGB\": \"<string>\",\n \"OutlineLineColorARGB\": \"<string>\",\n \"PartFillColorARGB\": \"<string>\",\n \"AutomaticallyChoosePartFillColor\": true\n }\n }\n}"

response = http.request(request)
puts response.read_body
{
  "NestData": [
    {
      "Base64EncodedNestRendering": "<string>",
      "NestedPartsData": [
        {
          "PartIDInNestPreview": 123,
          "Base64EncodedPartPreviewRendering": "<string>",
          "PartData": {
            "PartIdentifier": "<string>",
            "XDimMM": 123,
            "YDimMM": 123,
            "AreaMM2": 123,
            "CutLengthMM": 123,
            "InnerCutLengthMM": 123,
            "OuterCutLengthMM": 123,
            "NumberOfLoops": 123
          },
          "QuantityInNest": 123,
          "QuantityProducedInNest": 123,
          "QuantityInEntireNesting": 123
        }
      ],
      "NestEfficiency": 123,
      "SheetUtilization": 123,
      "NestingXDimMM": 123,
      "NestingYDimMM": 123,
      "SheetDetails": {
        "SheetIdentifier": "<string>",
        "XDimMM": 123,
        "YDimMM": 123,
        "AreaM2": 123
      },
      "PlacedPartsAreaM2": 123,
      "Multiplicity": 123,
      "CutLengthOfPlacedPartsMM": 123,
      "InnerCutLengthOfPlacedPartsMM": 123,
      "OuterCutLengthOfPlacedPartsMM": 123,
      "NumberOfRemnants": 123,
      "TotalAreaOfRemnantsMM2": 123
    }
  ],
  "OverallNestingEfficiency": 123,
  "OverallSheetUtilization": 123,
  "NumberOfNests": 123,
  "NumberOfSheets": 123,
  "NumberOfPlacedParts": 123,
  "AreaOfSheetsM2": 123,
  "AreaOfPlacedPartsM2": 123,
  "UnplacedParts": [
    {
      "UnplacedQuantity": 123,
      "PartIdentifier": "<string>",
      "XDimMM": 123,
      "YDimMM": 123,
      "AreaMM2": 123,
      "CutLengthMM": 123,
      "InnerCutLengthMM": 123,
      "OuterCutLengthMM": 123,
      "NumberOfLoops": 123
    }
  ],
  "PlacedParts": [
    {
      "PartIdentifier": "<string>",
      "XDimMM": 123,
      "YDimMM": 123,
      "AreaMM2": 123,
      "CutLengthMM": 123,
      "InnerCutLengthMM": 123,
      "OuterCutLengthMM": 123,
      "NumberOfLoops": 123
    }
  ],
  "MaterialRequirements": [
    {
      "Quantity": 123,
      "SheetIdentifier": "<string>",
      "XDimMM": 123,
      "YDimMM": 123,
      "AreaM2": 123
    }
  ],
  "CutLengthOfAllPlacedPartsMM": 123,
  "ResultIdentity": "<string>"
}

Authorizations

Authorization
string
header
required

Headers

Accept
enum<string>
required

Accept Header

Available options:
application/json

Query Parameters

RequestId
string
ResultIdentity
string
ReportSourceRenderingSettings
string

Body

application/json

FetchNestingResult

RequestId
string
ResultIdentity
string
ReportSourceRenderingSettings
ReportSourceRenderingSettings · object

ReportSourceRenderingSettings

Response

200 - application/json

Success

ReportSourceResponse

NestData
NestData · object[]
OverallNestingEfficiency
number<double>
OverallSheetUtilization
number<double>
NumberOfNests
integer<int32>
NumberOfSheets
integer<int32>
NumberOfPlacedParts
integer<int32>
AreaOfSheetsM2
number<double>
AreaOfPlacedPartsM2
number<double>
UnplacedParts
UnplacedPartData · object[]
PlacedParts
PartData · object[]
MaterialRequirements
MaterialRequirement · object[]
CutLengthOfAllPlacedPartsMM
number<double>
ResultIdentity
string