Normcut Nesting API (v1)

Download OpenAPI specification:Download

Buyer

Retrieves id of the authenticated buyer.

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
"497f6eca-6276-4993-bfeb-53cbbbba6f08"

Creates an invite code for a buyer which can be used by any other cutter to connect with this buyer.

Authorizations:
Bearer
path Parameters
buyerId
required
string <uuid>

The buyer identifier.

Responses

Retrieves detailed information for an invite code.

Authorizations:
Bearer
path Parameters
buyerId
required
string <uuid>

The buyer identifier.

inviteCodeId
required
string <uuid>

The invite code identifier.

Responses

Response samples

Content type
application/json
{
  • "created": "2019-08-24T14:15:22Z",
  • "expired": "2019-08-24T14:15:22Z",
  • "code": "string"
}

Cutter

Retrieves id of the authenticated cutter.

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
[
  • "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]

Retrieves information of a cutter.

Authorizations:
Bearer
path Parameters
cutterId
required
string <uuid>

The cutter identifier.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "email": "string"
}

Retrieves the default manufacturing parameters of a cutter.

Authorizations:
Bearer
path Parameters
cutterId
required
string <uuid>

The cutter identifier.

Responses

Response samples

Content type
application/json
{
  • "material": {
    },
  • "tools": [
    ],
  • "cutSpeed": 1
}

Updates the default manufacturing parameters of a cutter.

Authorizations:
Bearer
path Parameters
cutterId
required
string <uuid>

The cutter identifier.

Request Body schema: application/json
object (MaterialDto)

Data transfer object for a cutting plan material.

Array of objects or null (ToolDto) = 1 items

The tools.

cutSpeed
integer or null <int32> [ 1 .. 2147483647 ]

The cut speed.

Responses

Request samples

Content type
application/json
{
  • "material": {
    },
  • "tools": [
    ],
  • "cutSpeed": 1
}

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Deletes the default manufacturing parameters of a cutter.

Authorizations:
Bearer
path Parameters
cutterId
required
string <uuid>

The cutter identifier.

Responses

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Retrieves the default nesting parameters of a cutter.

Authorizations:
Bearer
path Parameters
cutterId
required
string <uuid>

The cutter identifier.

Responses

Response samples

Content type
application/json
{
  • "minimumPartSpacing": 100,
  • "minimumSheetPadding": 100,
  • "partRotationsCount": 1
}

Updates the default nesting parameters of a cutter.

Authorizations:
Bearer
path Parameters
cutterId
required
string <uuid>

The cutter identifier.

Request Body schema: application/json
minimumPartSpacing
number or null <float> [ 0 .. 100 ]

The intended minimum part spacing, i.e. the minimum distance between parts in millimeters, or {null} for the default application value.

minimumSheetPadding
number or null <float> [ 0 .. 100 ]

The intended minimum sheet spacing, i.e. the minimum distance between parts and the edge of a sheet in millimeters, or {null} for the default application value.

partRotationsCount
integer or null <int32> [ 1 .. 360 ]

The amount of allowed part rotations with each possible rotation angle being an integral multiple of 360 degrees divided by the rotation count or {null} for the default application value.

Responses

Request samples

Content type
application/json
{
  • "minimumPartSpacing": 100,
  • "minimumSheetPadding": 100,
  • "partRotationsCount": 1
}

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Deletes the default nesting parameters of a cutter.

Authorizations:
Bearer
path Parameters
cutterId
required
string <uuid>

The cutter identifier.

Responses

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

CutterBuyerConnection

Retrieves the CutterBuyerConnections associated to a cutter or buyer.

Authorizations:
Bearer
query Parameters
cutterId
string <uuid>
buyerId
string <uuid>

Responses

Response samples

Content type
application/json
[
  • "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]

Creates a new BuyerConnection connecting a cutter with another buyer by specifying an invite code.

For now only a Cutter can create a new CutterBuyerConnection, allowing the same for Buyers is not (yet) implemented.

Authorizations:
Bearer
query Parameters
cutterId
string <uuid>

The cutter identifier.

inviteCode
string

An invite code created by another buyer.

Responses

Retrieves details for a CutterBuyerConnection.

Authorizations:
Bearer
path Parameters
connectionId
required
string <uuid>

The CutterBuyerConnection identifier.

Responses

Response samples

Content type
application/json
{
  • "created": "2019-08-24T14:15:22Z",
  • "connectionId": "84b500d7-71c8-4b1f-adf4-f1eb0000973d",
  • "cutterIdentifier": "string",
  • "buyerIdentifier": "string",
  • "producedFillerPartsCount": 0
}

Deletes a CutterConnection for a buyer and by doing so stops considering the specific cutter for manufacturing filler parts.

Authorizations:
Bearer
path Parameters
connectionId
required
string <uuid>

The to be deleted CutterBuyerConnection identifier.

Responses

CuttingPlan

Retrieves a list of cutting plan identifiers associated to a cutter or a cutting plan geometry.

Only one parameter, either !:cutterId or !:cuttingPlanGeometryId, may be given. A combination of both results in an error.

Authorizations:
Bearer
query Parameters
cutterId
string <uuid>

The cutter identifier. Defaults to the cutter identifier associated to the authorized user.

cuttingPlanGeometryId
string <uuid>

The cutting plan geometry identifier.

Responses

Response samples

Content type
application/json
[
  • "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]

Creates a new cutting plan associated to a cutting plan geometry by specifying the material the cutting plan is produced from as well as the tools used to cut it.

If no material is specified only euro norm filler parts will be used in filler part nesting since these are material independent.

Authorizations:
Bearer
Request Body schema: application/json

The request data transfer object.

geometryId
required
string <uuid>

The cutting plan geometry identifier.

name
required
string

The name.

object (MaterialDto)

Data transfer object for a cutting plan material.

Array of objects or null (ToolDto) non-empty

The tools.

cutSpeed
integer or null <int32>

The cut speed or {null} if not yet known.

Responses

Request samples

Content type
application/json
{
  • "geometryId": "10ffb81c-c2bc-411d-8964-b5a2b796abc3",
  • "name": "string",
  • "material": {
    },
  • "tools": [
    ],
  • "cutSpeed": 0
}

Response samples

Content type
application/json
"497f6eca-6276-4993-bfeb-53cbbbba6f08"

Retrieves a cutting plan.

Authorizations:
Bearer
path Parameters
cuttingPlanId
required
string <uuid>

The cutting plan identifier.

Responses

Response samples

Content type
application/json
{
  • "geometryId": "10ffb81c-c2bc-411d-8964-b5a2b796abc3",
  • "name": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created": "2019-08-24T14:15:22Z",
  • "cutterId": "f1a0b298-4933-4669-a1fb-e20c03c8bbaa",
  • "material": {
    },
  • "tools": [
    ],
  • "cutSpeed": 0
}

Change CuttingPlan Values. Only Changing material settings is currently implemented. Those material settings can only be changed if they were wildcard before.

Authorizations:
Bearer
path Parameters
cuttingPlanId
required
string <uuid>

The cutting plan identifier.

Request Body schema: application/json

The parameters that should be updated. Only include parameters that should be updated.

object (MaterialDto)

Data transfer object for a cutting plan material.

Array of objects or null (ToolDto) non-empty

The tools.

cutSpeed
integer or null <int32>

The cut speed.

Responses

Request samples

Content type
application/json
{
  • "material": {
    },
  • "tools": [
    ],
  • "cutSpeed": 0
}

Response samples

Content type
No sample

/CuttingPlan/{cuttingPlanId}

Authorizations:
Bearer
path Parameters
cuttingPlanId
required
string <uuid>

Responses

Retrieves the stats of a cutting plan.

Authorizations:
Bearer
path Parameters
cuttingPlanId
required
string <uuid>

The cutting plan identifier.

Responses

Response samples

Content type
application/json
{
  • "overallArea": 0,
  • "share": 0,
  • "weight": 0,
  • "storedCo2": 0,
  • "contourLength": 0,
  • "cutDuration": 0
}

CuttingPlanGeometry

Retrieves a list of cutting plan geometry identifiers associated to a cutter.

Authorizations:
Bearer
query Parameters
cutterId
string <uuid>

The cutter identifier. Defaults to the cutter identifier associated to the authorized user.

excludeOptimized
boolean
Default: false

A flag indicating whether or not to exclude identifiers from cutting plan geometries that result from a cutting plan optimization.

Responses

Response samples

Content type
application/json
[
  • "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]

Creates a new cutting plan geometry.

Authorizations:
Bearer
Request Body schema: multipart/form-data
data
required
string <binary>

The cutting plan geometry file.

cutterId
string <uuid>

The identifier of the cutter that owns the cutting plan geometry.

minimumSheetEdgeLength
integer <int32> [ 0 .. 2147483647 ]
sheetIncluded
boolean

Whether the sheet is included within this cutting plan geometry.

name
required
string

The name.

Responses

Response samples

Content type
application/json
"497f6eca-6276-4993-bfeb-53cbbbba6f08"

Retrieves information about a cutting plan geometry.

Authorizations:
Bearer
path Parameters
cuttingPlanGeometryId
required
string <uuid>

The cutting plan geometry identifier.

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created": "2019-08-24T14:15:22Z",
  • "cutterId": "f1a0b298-4933-4669-a1fb-e20c03c8bbaa",
  • "optimized": true
}

/CuttingPlanGeometry/{cuttingPlanGeometryId}

Authorizations:
Bearer
path Parameters
cuttingPlanGeometryId
required
string <uuid>

Responses

/CuttingPlanGeometry/{cuttingPlanGeometryId}

Authorizations:
Bearer
path Parameters
cuttingPlanGeometryId
required
string <uuid>

Responses

Retrieves the geometric data of a cutting plan geometry.

Authorizations:
Bearer
path Parameters
cuttingPlanGeometryId
required
string <uuid>

The cutting plan geometry identifier.

query Parameters
FileExtension
string
ContentType
string
OtherContentTypes
Array of strings
pretty
boolean

A flag indicating whether or not the data should be styled. Ignored if the returned geometry data format is not NestingService.Models.GeometryDataFormat.Svg.

padding
integer <int32>

The padding of the returned styled SVG document, i.e. the inset distances of the sheet to the document bounds. Ignored if NestingService.Models.CuttingPlan.GetCuttingPlanGeometryDataStyleDto.Pretty is {false}.

object (Color)

The fill color of the sheet. Ignored if NestingService.Models.CuttingPlan.GetCuttingPlanGeometryDataStyleDto.Pretty is {false}.

object (Color)

The stroke color of the sheet. Ignored if NestingService.Models.CuttingPlan.GetCuttingPlanGeometryDataStyleDto.Pretty is {false}.

sheetStrokeWidth
integer <int32>

The stroke width of the sheet. Ignored if NestingService.Models.CuttingPlan.GetCuttingPlanGeometryDataStyleDto.Pretty is {false}.

object (Color)

The fill color of a part. Ignored if NestingService.Models.CuttingPlan.GetCuttingPlanGeometryDataStyleDto.Pretty is {false}.

object (Color)

The stroke color of a part. Ignored if NestingService.Models.CuttingPlan.GetCuttingPlanGeometryDataStyleDto.Pretty is {false}.

partStrokeWidth
integer <int32>

The stroke width of a part. Ignored if NestingService.Models.CuttingPlan.GetCuttingPlanGeometryDataStyleDto.Pretty is {false}.

object (Color)

The fill color of a filler part. Ignored if NestingService.Models.CuttingPlan.GetCuttingPlanGeometryDataStyleDto.Pretty is {false}.

object (Color)

The stroke color of a filler part. Ignored if NestingService.Models.CuttingPlan.GetCuttingPlanGeometryDataStyleDto.Pretty is {false}.

fillerPartStrokeWidth
integer <int32>

The stroke width of a filler part. Ignored if NestingService.Models.CuttingPlan.GetCuttingPlanGeometryDataStyleDto.Pretty is {false}.

intrinsicSize
boolean

A flag indicating whether or not to use the documents intrinsic size, i.e. the width and height resulting from the cutting plan geometry size and NestingService.Models.CuttingPlan.GetCuttingPlanGeometryDataStyleDto.Padding value. Ignored if NestingService.Models.CuttingPlan.GetCuttingPlanGeometryDataStyleDto.Pretty is {false}.

includeParts
boolean

A flag indicating whether or not to include parts in the document. Ignored if NestingService.Models.CuttingPlan.GetCuttingPlanGeometryDataStyleDto.Pretty is {false}.

includeFillerParts
boolean

A flag indicating whether or not to include filler parts in the document. Ignored if NestingService.Models.CuttingPlan.GetCuttingPlanGeometryDataStyleDto.Pretty is {false}.

Responses

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Retrieves the original cutting plan geometry file.

Authorizations:
Bearer
path Parameters
cuttingPlanGeometryId
required
string <uuid>

The cutting plan geometry identifier.

Responses

Response samples

Content type
No sample

CuttingPlanOptimization

Retrieves a list of cutting plan optimization identifiers. They are sorted by descending creation date. Latest creation date comes first.

Authorizations:
Bearer
query Parameters
cutterIds
Array of strings <uuid>

The cutter identifiers. Defaults to the cutter identifier associated to the authorized user.

cuttingPlanId
string <uuid>

The cutting plan identifier.

after
string <date-time>

The date after which the optimization should have been created. Should be provided in UTC time format and according to ISO 8601. e.g. 2011-10-05T14:48:00.000Z.

before
string <date-time>

The date before which the optimization should have been created. Should be provided in UTC time format and according to ISO 8601. e.g. 2011-10-05T14:48:00.000Z.

Responses

Response samples

Content type
application/json
{
  • "params": {
    },
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created": "2019-08-24T14:15:22Z",
  • "cuttingPlanId": "10376c9b-1ea7-4739-8cf6-8fce3793135e",
  • "optimizedGeometryId": "a4488d0b-6e81-4b93-be8c-65e3297c7586",
  • "state": 0,
  • "manufacturingState": 0
}

Creates a new cutting plan optimization.

Authorizations:
Bearer
Request Body schema: application/json

The request data transfer object.

cuttingPlanId
string <uuid>

The cutting plan identifier.

object (NestingParamsDto)

Data transfer object for parameters of a nesting job.

Responses

Request samples

Content type
application/json
{
  • "cuttingPlanId": "10376c9b-1ea7-4739-8cf6-8fce3793135e",
  • "params": {
    }
}

Response samples

Content type
application/json
"497f6eca-6276-4993-bfeb-53cbbbba6f08"

Evaluates all cutting plan optimizations owned by the authenticated user and summarizes relevant stats such as waste share.

Authorizations:
Bearer
query Parameters
cutterIds
Array of strings <uuid>

The cutter identifiers. Defaults to the cutter identifier associated to the authorized user.

after
string <date-time>

The date after which the optimization should have been created. Should be provided in UTC time format and according to ISO 8601. e.g. 2011-10-05T14:48:00.000Z.

before
string <date-time>

The date before which the optimization should have been created. Should be provided in UTC time format and according to ISO 8601. e.g. 2011-10-05T14:48:00.000Z.

Responses

Response samples

Content type
application/json
{
  • "numberOfCuttingPlanOptimizations": 0,
  • "original": {
    },
  • "optimized": {
    }
}

Retrieves a cutting plan optimization.

Authorizations:
Bearer
path Parameters
cuttingPlanOptimizationId
required
string <uuid>

The cutting plan optimization identifier.

Responses

Response samples

Content type
application/json
{
  • "params": {
    },
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created": "2019-08-24T14:15:22Z",
  • "cuttingPlanId": "10376c9b-1ea7-4739-8cf6-8fce3793135e",
  • "optimizedGeometryId": "a4488d0b-6e81-4b93-be8c-65e3297c7586",
  • "state": 0,
  • "manufacturingState": 0
}

Updates a cutting plan optimization.

Authorizations:
Bearer
path Parameters
cuttingPlanOptimizationId
required
string <uuid>

The cutting plan optimization identifier.

Request Body schema:

The request data transfer object.

manufacturingState
integer <int32> (CuttingPlanOptimizationManufacturingState)
Enum: 0 1 2

Describes the current manufacturing state of a cutting plan optimization.

Responses

Request samples

Content type
{
  • "manufacturingState": 0
}

/CuttingPlanOptimization/{cuttingPlanOptimizationId}

Authorizations:
Bearer
path Parameters
cuttingPlanOptimizationId
required
string <uuid>

Responses

Retrieves a marketplace URL for a cutting plan optimization.

Authorizations:
Bearer
path Parameters
cuttingPlanOptimizationId
required
string <uuid>

The cutting plan optimization identifier.

Responses

Response samples

Content type
application/json
"string"

Retrieves the stats of a cutting plan optimization.

Authorizations:
Bearer
path Parameters
cuttingPlanOptimizationId
required
string <uuid>

The cutting plan optimization identifier.

Responses

Response samples

Content type
application/json
{
  • "overallArea": 0,
  • "share": 0,
  • "weight": 0,
  • "storedCo2": 0,
  • "contourLength": 0,
  • "cutDuration": 0
}

FillerPartGeometry

Retrieves a list of filler part geometry identifiers that are either associated to a buyer or marked as public.

Authorizations:
Bearer
query Parameters
buyerId
string <uuid>

The buyer identifier. Defaults to the buyer identifier associated to the authorized user.

Responses

Response samples

Content type
application/json
[
  • "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]

Creates a new filler part geometry.

Authorizations:
Bearer
Request Body schema: multipart/form-data
data
required
string <binary>

The filler part geometry file.

buyerId
string <uuid>

The identifier of the buyer that owns the filler part geometry.

name
required
string

A user-defined name.

Responses

Response samples

Content type
application/json
"497f6eca-6276-4993-bfeb-53cbbbba6f08"

Retrieves information about a filler part geometry.

Authorizations:
Bearer
path Parameters
fillerPartGeometryId
required
string <uuid>

The filler part geometry identifier.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created": "2019-08-24T14:15:22Z",
  • "buyerId": "7925fb6c-1391-458a-9144-275078d9f24b",
  • "name": "string"
}

/FillerPartGeometry/{fillerPartGeometryId}

Authorizations:
Bearer
path Parameters
fillerPartGeometryId
required
string <uuid>

Responses

/FillerPartGeometry/{fillerPartGeometryId}

Authorizations:
Bearer
path Parameters
fillerPartGeometryId
required
string <uuid>

Responses

Retrieves the geometric data of a filler part geometry.

Authorizations:
Bearer
path Parameters
fillerPartGeometryId
required
string <uuid>

The filler part geometry identifier.

query Parameters
pretty
boolean

A flag indicating whether or not the data should be styled. Ignored if the returned geometry data format is not NestingService.Models.GeometryDataFormat.Svg.

padding
integer <int32>

The padding of the returned styled SVG document, i.e. the inset distances of the filler part to the document bounds. Ignored if NestingService.Models.FillerPart.GetFillerPartGeometryDataSvgStyleDto.Pretty is {false}.

object (Color)

The fill color of the part. Ignored if NestingService.Models.FillerPart.GetFillerPartGeometryDataSvgStyleDto.Pretty is {false}.

object (Color)

The stroke color of the part. Ignored if NestingService.Models.FillerPart.GetFillerPartGeometryDataSvgStyleDto.Pretty is {false}.

strokeWidth
integer <int32>

The stroke width of the part. Ignored if NestingService.Models.FillerPart.GetFillerPartGeometryDataSvgStyleDto.Pretty is {false}.

intrinsicSize
boolean

A flag indicating whether or not to use the documents intrinsic size, i.e. the width and height resulting from the filler part size and NestingService.Models.FillerPart.GetFillerPartGeometryDataSvgStyleDto.Padding value. Ignored if NestingService.Models.FillerPart.GetFillerPartGeometryDataSvgStyleDto.Pretty is {false}.

Responses

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

FillerPartInstance

Retrieves a list of filler part instance identifiers associated to a filler part or a cutting plan optimization.

Authorizations:
Bearer
query Parameters
fillerPartId
string <uuid>

The filler part identifier.

optimizationId
string <uuid>

The optimization identifier.

Responses

Response samples

Content type
application/json
[
  • "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]

Retrieves a filler part instance.

Authorizations:
Bearer
path Parameters
fillerPartInstanceId
required
string <uuid>

The filler part instance identifier.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "fillerPartId": "b8b6c603-fc27-48b1-a4ef-3e9dbab22c6b",
  • "cuttingPlanOptimizationId": "36c182cc-852f-405d-ac86-ab2ca4d149e3"
}

FillerPartOrder

Retrieves a list of filler part order identifiers associated to a buyer or a filler part.

Authorizations:
Bearer
query Parameters
buyerId
string <uuid>

The buyer identifier. Defaults to the buyer identifier associated to the authorized user.

Responses

Response samples

Content type
application/json
[
  • "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]

Creates a new filler part order.

Authorizations:
Bearer
Request Body schema: application/json

The request data transfer object.

buyerId
string or null <uuid>

The identifier of the buyer that owns the filler part.

name
required
string

A user-defined name.

Responses

Request samples

Content type
application/json
{
  • "buyerId": "7925fb6c-1391-458a-9144-275078d9f24b",
  • "name": "string"
}

Response samples

Content type
application/json
"497f6eca-6276-4993-bfeb-53cbbbba6f08"

Retrieves a filler part order.

Authorizations:
Bearer
path Parameters
fillerPartOrderId
required
string <uuid>

The filler part order identifier.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created": "2019-08-24T14:15:22Z",
  • "buyerId": "7925fb6c-1391-458a-9144-275078d9f24b",
  • "name": "string",
  • "state": 0
}

Updates a filler part order.

Authorizations:
Bearer
path Parameters
fillerPartOrderId
required
string <uuid>

The filler part order identifier.

Request Body schema: application/json

The request data transfer object.

state
integer <int32> (FillerPartOrderState)
Enum: 0 1 2 3 4

Describes the current state of a filler part order.

Responses

Request samples

Content type
application/json
{
  • "state": 0
}

Response samples

Content type
No sample

Deletes a filler part order and its associated filler parts.

Authorizations:
Bearer
path Parameters
fillerPartOrderId
required
string <uuid>

The filler part order identifier.

Responses

Response samples

Content type
No sample

Retrieves a list of filler part identifiers in a filler part order.

Authorizations:
Bearer
path Parameters
fillerPartOrderId
required
string <uuid>

The filler part order identifier.

Responses

Response samples

Content type
application/json
[
  • "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]

Creates a new filler part in a filler part order.

Leaving out certain material specifications will be interpreted as "wildcards" i.e. filler part will be matched with cutting plans from any material.

Authorizations:
Bearer
path Parameters
fillerPartOrderId
required
string <uuid>

The filler part order identifier.

Request Body schema: application/json

The request data transfer object.

geometryId
required
string <uuid>

The filler part geometry identifier.

name
required
string

A user-defined name.

required
object (MaterialDto)

Data transfer object for a cutting plan material.

amount
required
integer <int32> [ 1 .. 2147483647 ]

The requested amount.

Responses

Request samples

Content type
application/json
{
  • "geometryId": "10ffb81c-c2bc-411d-8964-b5a2b796abc3",
  • "name": "string",
  • "material": {
    },
  • "amount": 1
}

Response samples

Content type
application/json
"497f6eca-6276-4993-bfeb-53cbbbba6f08"

Retrieves a filler part from a filler part order.

Authorizations:
Bearer
path Parameters
fillerPartOrderId
required
string <uuid>

The filler part order identifier.

fillerPartId
required
string <uuid>

The filler part identifier.

Responses

Response samples

Content type
application/json
{
  • "geometryId": "10ffb81c-c2bc-411d-8964-b5a2b796abc3",
  • "name": "string",
  • "material": {
    },
  • "amount": 1,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created": "2019-08-24T14:15:22Z",
  • "orderId": "b3e1eced-f2bd-4d8c-9765-fbc9d1d222d5"
}

/FillerPartOrder/{fillerPartOrderId}/fillerPart/{fillerPartId}

Authorizations:
Bearer
path Parameters
fillerPartOrderId
required
string <uuid>
fillerPartId
required
string <uuid>

Responses

/FillerPartOrder/{fillerPartOrderId}/fillerPart/{fillerPartId}

Authorizations:
Bearer
path Parameters
fillerPartOrderId
required
string <uuid>
fillerPartId
required
string <uuid>

Responses

NestingOrder

Initiates a nesting order with client-provided sheet and part specifications as well as execution parameters.

Authorizations:
Bearer
Request Body schema: application/json
required
object (SheetDto)

Data transfer object for a sheet specification of a nesting order.

required
Array of objects (PartDto)

The list of part models for the nesting order.

object (NestingParamsDto)

Data transfer object for parameters of a nesting job.

Responses

Request samples

Content type
application/json
{
  • "sheet": {
    },
  • "parts": [
    ],
  • "params": {
    }
}

Response samples

Content type
application/json
"497f6eca-6276-4993-bfeb-53cbbbba6f08"

Returns a nesting order.

Authorizations:
Bearer
path Parameters
nestingOrderId
required
string <uuid>

The nesting order identifier.

Responses

Response samples

Content type
application/json
{
  • "sheet": {
    },
  • "parts": [
    ],
  • "params": {
    },
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "state": "string",
  • "created": "2019-08-24T14:15:22Z"
}

Returns the positioning of parts for a previously processed nesting order, expressed by their relative transformations within the sheet.

Authorizations:
Bearer
path Parameters
nestingOrderId
required
string <uuid>

The identifier of the previously processed nesting order.

Responses

Response samples

Content type
application/json
{
  • "partPositioning": [
    ]
}

Creates a cutting plan for a previously processed nesting order and returns its identifier.

Authorizations:
Bearer
path Parameters
nestingOrderId
required
string <uuid>

The identifier of the previously processed nesting order.

query Parameters
tightenSheet
integer <int32> (ShrinkSheetOptions)
Enum: 0 1 2 3

Whether the used sheet should be shrunk to fit the placed parts (respecting min distances).

Responses

Response samples

Content type
application/json
"497f6eca-6276-4993-bfeb-53cbbbba6f08"