logo
API docs by Redocly

up2parts API

Download OpenAPI specification:Download

Under Construction

Please note that our API is under construction. New endpoints will be added constantly, and existing definitions are subject to change without prior notice. We do our utmost to ensure that all changes are backward compatible and your effort to implement our API does not get lost.

Introduction

The up2parts API is designed to programmatically get and modify data in up2parts with the specific goal to make it possible to integrate up2parts with other tools in a company's infrastructure like an ERP system. The integration to an ERP system makes it possible that basic objects needed for up2parts software products can be maintained in one system only, and the data can be automatically synchronized to up2parts.

Note: The up2parts API will give only the possibility to access or modify data in up2parts and is not a full integration solution.

up2parts API can be accessed by sending a properly formed HTTP request to the https://api.up2parts.com address.

API Playground

To develop an app connected to the up2parts API you might need a playground where the production data is not modified in any way. With this, you can develop and test your application and our API in a safe environment. To get playground access, please contact our support. https://www.up2parts.com/en/support/contact

Incomplete Data

To be able to synchronize as much data from the ERP system to up2parts our API allows creating objects that are mandatory for other up2parts components to use. For example, you can create a material without the material group given. If the API definition allows it, this data will be stored but will not be used by other up2parts components. This data can be adjusted and completed in the up2parts GUI. (Coming soon.)

Errors

The up2parts API uses standard HTTP response codes to indicate the success or failure of an API request. In general: Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error in the information provided (e.g., a required parameter is missing, the parameter does not fulfill the requirements.). Codes in the 5xx range indicate an error with the up2parts servers.

In the event of an error, more detailed information is returned in the response body in JSON encoded format.

Property Description
name Mandatory. Name of the error
message Mandatory. human-readable message that explains the reason and details of the error.
errors Optional. If we can provide additional information on the issue this error list will be available in the response. The structure of this field equals the errors defined here: https://github.com/typestack/class-validator#validation-errors

Authentication

The up2parts API uses API keys to authenticate requests. You can manage your API key on the up2parts administration page. Only administrators have permission for handling API keys.

Note: To use the API key, it has to be added to the request header:

Request Header:
{
  ...,
  "X-API-KEY": "Up2Parts-API-Key"
}

Material Group

Material group in up2parts identifies the basic material without specifying the exact alloy or sub type. In up2parts it is used for grouping materials. The list of material groups cannot be changed by the user. For each material group a default density is available which will be used in case no density value is specified when creating a material over the API.

List of available material groups on the up2parts API:

Identifier Description (en / de) Default density (g/cm3)
aluminium Aluminium / Aluminium 2.7
brass Brass / Messing 8.7
bronze Bronze / Bronze 8.7
cast_iron Cast iron / Gusseisen 7.2
copper Copper / Kupfer 8.9
nickel Nickel / Nickel 8.9
plastic Plastic / Kunststoff 2
stainless_steel Stainless steel / Edelstahl 7.7
steel Stahl / Steel 7.8
titanium Titanium / Titan 4.5
zirconium Zirconium / Zirkonium 6.5

Density Unit

Density of a material is its mass per unit volume. In up2parts API multiple density units can be used together with the density. Therefore the density unit conversion is not needed before data can be sent to up2parts.

List of possible density units:

Value Description Conversion factor to g/cm3 Denisty Value Range
g/cm3 grams per cubic centimeter 1 0 - 1
g/mm3 grams per cubic millimeter 1000 0 - 1 000
kg/m3 kilograms per cubic meter 1 / 1000 0 - 1 000 000

Material

Material is the very specific type or alloy of a material group. For example “3.1645 | EN AW-2007 | AlCuMgPb” can be a material with material group “aluminium”. List of materials are not predefined they must be filled by the user.

List materials

Returns all available materials in the system.

Authorizations:
apiKey

Responses

Response samples

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

Create Material API

Add a material to up2parts cloud basic

Authorizations:
apiKey
Request Body schema: application/json
name
string [ 1 .. 64 ] characters

Name of the material

description
string or null <= 1024 characters

Description of the material

density
number or null >= 0

Density value for the material. In case density is "null" the default density of the material group will be used. If material group is "null" density must not be "null".

densityUnit
string or null
Default: "g/cm3"
Enum: "g/cm3" "g/mm3" "kg/m3"
materialGroup
string or null
Enum: "aluminium" "brass" "bronze" "cast_iron" "copper" "nickel" "plastic" "stainless_steel" "steel" "titanium" "zirconium"

Identifier of the material group. If density is “null” material group must have a value. See also the chapter "Material Group".

externalReferenceId
string or null [ 1 .. 64 ] characters

Identifier from the external system from where the material was synchronized to up2parts. Can be used to bind the objects with the same meaning between the two systems. If not null it may neither be an empty string nor a string that only contains whitespace characters

Responses

Request samples

Content type
application/json
{
  • "name": "3.1645 | EN AW-2007 | AlCuMgPb",
  • "description": "Solidifaction range C: 507-650; Electrical Conductivity: MS/m: 18-22",
  • "density": 2850,
  • "densityUnit": "kg/m3",
  • "materialGroup": "aluminium",
  • "externalReferenceId": "1234-ERP-5678"
}

Response samples

Content type
application/json
{
  • "id": "7636d2a8-f61f-406f-83cb-d445545b85de",
  • "name": "3.1645 | EN AW-2007 | AlCuMgPb",
  • "description": "Solidifaction range C: 507-650; Electrical Conductivity: MS/m: 18-22",
  • "density": 2.85,
  • "densityUnit": "g/cm3",
  • "materialGroup": "aluminium",
  • "externalReferenceId": "1234-ERP-5678"
}

Retrieve a material

Retrieves the details of a material. Supply the internal ID received by creation of the material or the external reference ID given in the created material request.

Authorizations:
apiKey
path Parameters
id
required
string

ID of the requested material. If the query parameter type is set to id (default if parameter is missing) than the internal UUID is used received by creation of the material. If query param is set to refid than the external reference ID string is used for the request that was given in the external Reference ID attribute.

query Parameters
type
string or null
Enum: "id" "refid"

Identifies which type of ID is used in the query

Responses

Response samples

Content type
application/json
{
  • "id": "7636d2a8-f61f-406f-83cb-d445545b85de",
  • "name": "3.1645 | EN AW-2007 | AlCuMgPb",
  • "description": "Solidifaction range C: 507-650; Electrical Conductivity: MS/m: 18-22",
  • "density": 2.85,
  • "densityUnit": "g/cm3",
  • "materialGroup": "aluminium",
  • "externalReferenceId": "1234-ERP-5678"
}

Delete a material

Deletes a material. Supply the internal ID received by creation of the material or the external reference ID given in the created material request.

Authorizations:
apiKey
path Parameters
id
required
string

ID of the material to be deleted. If the query parameter type is set to id (default if parameter is missing) than the internal UUID is used received by creation of the material. If query param is set to refid than the external reference ID string is used for the request that was given in the external Reference ID attribute.

query Parameters
type
string or null
Enum: "id" "refid"

Identifies which type of ID is used in the query

Responses

Shapes

For each shape, different dimensions must be given. The following table provides a summary of the necessary dimensions.

Shape Used dimensions Dimension illustration
flat_bar width (a)
thickness (b)
length (c)		 Dimension explanation image: flat_bar
round_bar diameter (a)
length (b)		 Dimension explanation image: round_bar
hexagon height (a)
length (b)		 Dimension explanation image: hexagon
sheet width (a)
length (b)
thickness (c)		 Dimension explanation image: sheet
square_bar width (a)
length (b)		 Dimension explanation image: square_bar
round_tube diameter (a)
thickness (b)
length (c)		 Dimension explanation image: round_tube
l_profile height (a)
width (b)
thickness (c)
length (d)		 Dimension explanation image: l_profile

Rawmaterial

Raw materials are materials used for production, as they can be ordered by suppliers. up2parts can give suggestions on which raw materials can be used to produce a specific part. For this, the raw material must be available first in up2parts cloud basic.

List raw materials

Returns all available raw materials in the system.

Authorizations:
apiKey

Responses

Response samples

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

Create Raw material API

Add a raw material to up2parts cloud basic

Authorizations:
apiKey
Request Body schema: application/json
name
string [ 1 .. 64 ] characters

Name of the raw material

description
string or null <= 1024 characters

Description of the raw material

articleNumber
string or null <= 40 characters

Article number of the raw material as it is used in the ERP system or other catalogs.

procurementTime
integer or null [ 0 .. 999 ]

The number of days how long the procurement of this raw material is.

price
number [ 0 .. 999999.99 ]

Price for the raw material in EUR/kg. Price is considered during calculation for raw material is selected

externalReferenceId
string or null [ 1 .. 64 ] characters

Identifier from the external system from where the material was synchronized to up2parts. If not “null”, it may neither be an empty string nor a string that only contains whitespace characters.

materialReferenceType
string or null
Enum: "materialId" "materialExternalReferenceId"

The type of ID used for identifying the material

materialId
string or null <uuid>

Unique identifier of the material.

materialExternalReferenceId
string or null [ 1 .. 64 ] characters

Identifier from the external system from where the material was synchronized to up2parts.

shapeType
string or null

The shape of the raw material. See also the chapter “Shapes”.

diameter
number [ 0 .. 100000 ]

Diameter of the raw material.

thickness
number [ 0 .. 100000 ]

The thickness of the raw material.

length
number [ 0 .. 100000 ]

Length of the raw material.

Responses

Request samples

Content type
application/json
Example
{
  • "name": "Raw material 3.3206",
  • "description": "Supplier: BAM Gmbh.",
  • "articleNumber": 20546,
  • "procurementTime": 5,
  • "price": 4.2,
  • "externalReferenceId": "1234-ERP-5678",
  • "materialReferenceType": "id",
  • "materialId": "7636d2a8-f61f-406f-83cb-d445545b85de",
  • "materialExternalReferenceId": "string",
  • "shapeType": "round_tube",
  • "diameter": 25,
  • "thickness": 2,
  • "length": 6000
}

Response samples

Content type
application/json
{
  • "id": "7636d2a8-f61f-406f-83cb-d445545b85de",
  • "name": "Raw material 3.3206",
  • "description": "Supplier: BAM Gmbh.",
  • "material": {
    },
  • "articleNumber": 20546,
  • "procurementTime": 5,
  • "price": 4.2,
  • "externalReferenceId": "1234-ERP-5678",
  • "shapeType": "flat_bar",
  • "width": 30,
  • "height": 20,
  • "length": 6000,
  • "diameter": 25,
  • "thickness": 2
}

Retrieve a raw material

Retrieves the details of a raw material. Supply the internal ID received by creation of the raw material or the external reference ID given in the created raw material request.

Authorizations:
apiKey
path Parameters
id
required
string

ID of the requested raw material. If the query parameter type is set to id (default if parameter is missing) than the internal UUID is used received by creation of the raw material. If query param is set to refid than the external reference ID string is used for the request that was given in the external Reference ID attribute.

query Parameters
type
string or null
Enum: "id" "refid"

Identifies which type of ID is used in the query

Responses

Response samples

Content type
application/json
{
  • "id": "7636d2a8-f61f-406f-83cb-d445545b85de",
  • "name": "Raw material 3.3206",
  • "description": "Supplier: BAM Gmbh.",
  • "material": {
    },
  • "articleNumber": 20546,
  • "procurementTime": 5,
  • "price": 4.2,
  • "externalReferenceId": "1234-ERP-5678",
  • "shapeType": "flat_bar",
  • "width": 30,
  • "height": 20,
  • "length": 6000,
  • "diameter": 25,
  • "thickness": 2
}

Update a raw material

It updates several details about the raw material. The raw material to modify must be specified in the path parameter. Only some properties can be changed, which do not alter the raw material completely.

Authorizations:
apiKey
path Parameters
id
required
string

ID of the raw material to be updated. If the query parameter type is set to id (default if parameter is missing) than the internal UUID is used received by creation of the raw material. If query param is set to refid than the external reference ID string is used for the request that was given in the external Reference ID attribute.

query Parameters
type
string or null
Enum: "id" "refid"

Identifies which type of ID is used in the query

Request Body schema: application/json
name
string or undefined [ 1 .. 64 ] characters

Name of the raw material

description
string or null <= 1024 characters

Description of the raw material

articleNumber
string or null <= 40 characters

Article number of the raw material as it is used in the ERP system or other catalogs.

procurementTime
integer or null [ 0 .. 999 ]

The number of days how long the procurement of this raw material is.

price
number [ 0 .. 999999.99 ]

Price for the raw material in EUR/kg. Price is considered during calculation for raw material is selected

externalReferenceId
string or null [ 1 .. 64 ] characters

Identifier from the external system from where the material was synchronized to up2parts. If not “null”, it may neither be an empty string nor a string that only contains whitespace characters.

Responses

Request samples

Content type
application/json
{
  • "name": "Raw material 3.3206",
  • "description": "Supplier: BAM Gmbh.",
  • "articleNumber": 20546,
  • "procurementTime": 5,
  • "price": 4.2,
  • "externalReferenceId": "1234-ERP-5678"
}

Response samples

Content type
application/json
{
  • "id": "7636d2a8-f61f-406f-83cb-d445545b85de",
  • "name": "Raw material 3.3206",
  • "description": "Supplier: BAM Gmbh.",
  • "material": {
    },
  • "articleNumber": 20546,
  • "procurementTime": 5,
  • "price": 4.2,
  • "externalReferenceId": "1234-ERP-5678",
  • "shapeType": "flat_bar",
  • "width": 30,
  • "height": 20,
  • "length": 6000,
  • "diameter": 25,
  • "thickness": 2
}

Delete a raw material

Deletes a raw material. Supply the internal ID received by creation of the raw material or the external reference ID given in the created raw material request.

Authorizations:
apiKey
path Parameters
id
required
string

ID of the raw material to be deleted. If the query parameter type is set to id (default if parameter is missing) than the internal UUID is used received by creation of the raw material. If query param is set to refid than the external reference ID string is used for the request that was given in the external Reference ID attribute.

query Parameters
type
string or null
Enum: "id" "refid"

Identifies which type of ID is used in the query

Responses

Resource

A resource is an object needed to execute a step in a production plan. These can be different types of machines like turning or milling machines or other internal or external resources like packaging or quality check.

List resources

Returns all resources in the system.

Authorizations:
apiKey

Responses

Response samples

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

Create Resource

Add a resource to up2parts cloud basic

Authorizations:
apiKey
Request Body schema: application/json
name
string [ 1 .. 64 ] characters

Name of the resource

description
string or null <= 1024 characters

Description of the resource.

materialGroups
Array of strings or null (MaterialGroup)
Items Enum: "aluminium" "brass" "bronze" "cast_iron" "copper" "nickel" "plastic" "stainless_steel" "steel" "titanium" "zirconium"

The list of material groups which can be processed by the resource. An empty list or “null” means that the resource can process all types of material groups.

externalReferenceId
string or null [ 1 .. 64 ] characters

Identifier from the external system from where the resource was synchronized to up2parts. Can be used to bind the objects with the same meaning between the two systems. If not null it may neither be an empty string nor a string that only contains whitespace characters.

serialNumber
string or null <= 64 characters

Serial number of the resource.

costType
string
Value: "time"

Unit type of the cost of the resource. Currently, only time-based resources can be handled by up2parts API.

setupRate
number

Price per hour in cent to set up the resource.

runTimeRate
number

Price per hour in cent for resource run time.

avarageSetupTime
integer [ 0 .. 359999 ]

The average time to set up the resource in seconds.

processGroup
string or null
Enum: "additive:fdm" "additive:sls" "additive:slm" "additive:mjf" "additive:polyjet" "additive:sla" "additive:metal_deposition_welding" "cleaning:manual" "cleaning:automated" "deburring:manual" "deburring:automated" "erosive:sinker_edm" "erosive:wire_edm" "erosive:start_hole_drilling_edm" "forming:bending" "forming:rollers" "forming:forging" "forming:orbital_forming" "grinding_and_finish:surface_grinding" "grinding_and_finish:cylindrical_grinding" "grinding_and_finish:non_cylindrical_grinding" "grinding_and_finish:gear_grinding" "grinding_and_finish:jig_grinding" "grinding_and_finish:honing" "grinding_and_finish:electropolishing" "grinding_and_finish:vibratory_grinding" "grinding_and_finish:plasma_polishing" "grinding_and_finish:lapping" "grinding_and_finish:abrasive_flow_machining" "grinding_and_finish:polishing" "grinding_and_finish:manual" "heat_treatment:tempering" "heat_treatment:case_hardening" "heat_treatment:through_hardening" "heat_treatment:ignited_basis" "heat_treatment:annealing" "heat_treatment:vacuum_hardening" "heat_treatment:gas_nitriding" "heat_treatment:plasma_nitriding" "heat_treatment:hardening" "heat_treatment:nitrocarburizing" "heat_treatment:induction_hardening" "heat_treatment:general" "joining:welding" "joining:bonding" "joining:friction_welding" "joining:hard_soldering" "joining:soft_soldering" "labeling:engraving" "labeling:laser" "logistics:material_preparation" "logistics:packaging" "logistics:shipping" "manual_tasks:work_planning" "manual_tasks:mechanical_joining" "manual_tasks:hand_over" "manual_tasks:tool_setup" "manual_tasks:workbench" "programming:manual" "programming:automated" "quality_management:coordinate_measuring_machine" "quality_management:manual_dimensional_check" "separating:laser_cutting" "separating:waterjet_cutting" "separating:punch" "separating:band_sawing" "separating:circular_sawing" "subtractive:milling" "subtractive:turning" "subtractive:broaching" "subtractive:profile_milling" "surface_treatment:anodizing" "surface_treatment:hard_coating" "surface_treatment:sandblasting" "surface_treatment:chrome_plating" "surface_treatment:galvanizing" "surface_treatment:nickel_plating" "surface_treatment:varnishing" "surface_treatment:burning" "surface_treatment:cvd_coating" "surface_treatment:anticorrosive_coating" "surface_treatment:pvd_coating"

In a process group, procedures, and work steps are meaningfully summarized. This property is showing what type of work the given resource can do. This setting is taken into account in the automatic price calculation.

Responses

Request samples

Content type
application/json
{
  • "name": "DMG Mori DMU 50",
  • "description": "speedMASTER 20,000 rpm with 35kW and 130Nm",
  • "materialGroups": [
    ],
  • "externalReferenceId": "123-456",
  • "serialNumber": "ABC123DE9876543210",
  • "costType": "time",
  • "setupRate": 52,
  • "runTimeRate": 103,
  • "avarageSetupTime": 3600,
  • "processGroup": "additive:fdm"
}

Response samples

Content type
application/json
{
  • "id": "e0ad0524-2d15-4e04-9a8a-8ae9e9805d3v",
  • "name": "DMG Mori DMU 50",
  • "description": "speedMASTER 20,000 rpm with 35kW and 130Nm",
  • "materialGroups": [
    ],
  • "externalReferenceId": "123-456",
  • "serialNumber": "ABC123DE9876543210",
  • "costType": "time",
  • "setupRate": 52,
  • "runTimeRate": 103,
  • "avarageSetupTime": 3600,
  • "processGroup": "additive:fdm"
}

Delete a resource

Deletes a resource. Supply the internal ID received by creation of the resource or the external reference ID given in the created resource request.

Authorizations:
apiKey
path Parameters
id
required
string

ID of the resource to be deleted. If the query parameter type is set to id (default if parameter is missing) than the internal UUID is used received by creation of the resource. If query param is set to refid than the external reference ID string is used for the request that was given in the external Reference ID attribute.

query Parameters
type
string or null
Enum: "id" "refid"

Identifies which type of ID is used in the query

Responses

Patch a resource

Patch a resource. Supply the internal ID received by creation of the resource or the external reference ID given in the created resource request.

Authorizations:
apiKey
path Parameters
id
required
string

ID of the resource to be patched. If the query parameter type is set to id (default if parameter is missing) than the internal UUID is used received by creation of the resource. If query param is set to refid than the external reference ID string is used for the request that was given in the external Reference ID attribute.

query Parameters
type
string or null
Enum: "id" "refid"

Identifies which type of ID is used in the query

Request Body schema: application/json
name
string [ 1 .. 64 ] characters

Name of the resource

description
string or null <= 1024 characters

Description of the resource.

materialGroups
Array of strings or null (MaterialGroup)
Items Enum: "aluminium" "brass" "bronze" "cast_iron" "copper" "nickel" "plastic" "stainless_steel" "steel" "titanium" "zirconium"

The list of material groups which can be processed by the resource. An empty list or “null” means that the resource can process all types of material groups.

externalReferenceId
string or null [ 1 .. 64 ] characters

Identifier from the external system from where the resource was synchronized to up2parts. Can be used to bind the objects with the same meaning between the two systems. If not null it may neither be an empty string nor a string that only contains whitespace characters.

serialNumber
string or null <= 64 characters

Serial number of the resource.

setupRate
number

Price per hour in cent to set up the resource.

runTimeRate
number

Price per hour in cent for resource run time.

avarageSetupTime
integer [ 0 .. 359999 ]

The average time to set up the resource in seconds.

Responses

Request samples

Content type
application/json
{
  • "name": "DMG Mori DMU 50",
  • "description": "speedMASTER 20,000 rpm with 35kW and 130Nm",
  • "materialGroups": [
    ],
  • "externalReferenceId": "123-456",
  • "serialNumber": "ABC123DE9876543210",
  • "setupRate": 52,
  • "runTimeRate": 103,
  • "avarageSetupTime": 3600
}

Response samples

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

Retrieve a resource

Retrieves the details of a resource. Supply the internal ID received by creation of the resource or the external reference ID given in the created resource request.

Authorizations:
apiKey
path Parameters
id
required
string

ID of the requested resource. If the query parameter type is set to id (default if parameter is missing) than the internal UUID is used received by creation of the resource. If query param is set to refid than the external reference ID string is used for the request that was given in the external Reference ID attribute.

query Parameters
type
string or null
Enum: "id" "refid"

Identifies which type of ID is used in the query

Responses

Response samples

Content type
application/json
{
  • "id": "e0ad0524-2d15-4e04-9a8a-8ae9e9805d3v",
  • "name": "DMG Mori DMU 50",
  • "description": "speedMASTER 20,000 rpm with 35kW and 130Nm",
  • "materialGroups": [
    ],
  • "externalReferenceId": "123-456",
  • "serialNumber": "ABC123DE9876543210",
  • "costType": "time",
  • "setupRate": 52,
  • "runTimeRate": 103,
  • "avarageSetupTime": 3600,
  • "processGroup": "additive:fdm"
}

Part

The part is the object that is planned to be manufactured. The CAD file of the part should be uploaded to up2parts in step format to make a similarity search or to create a work plan.

Create Part API

Add a part to up2parts cloud basic

Authorizations:
apiKey
Request Body schema: multipart/formdata
object (part)
file
string <binary>

The STEP-file that represents the 3D object to be manufactured. Only step files are accepted up to the size of 10MBytes.

Responses

Request samples 

curl --location --request POST 'https://api.up2parts.com/v1/part/'
            --header 'x-api-key: 123456abcdf78910stofi'
            --form 'file=@"/C:/Users/stofi/Downloads/Fraesteil.step"' 
            --form 'part="{
              "name": "Milling Part",
              "description": "string",
              "articleNumber": "Article1234",
              "tolerance": "ISO_2768-1_c",
              "drawingNumber": "1234",
              "indexStatus": "string",
              "materialId": "7636d2a8-f61f-406f-83cb-d445545b85de",
              "materialReferenceType": "id"
            }"'

Response samples

Content type
application/json
{
  • "id": "7636d2a8-f61f-406f-83cb-d445545b85de",
  • "name": "Milling Part",
  • "description": "string",
  • "tolerance": "ISO_2768-1_c",
  • "articleNumber": "Article1234",
  • "drawingNumber": 1234,
  • "indexStatus": "string",
  • "externalReferenceId": "ERP-1234",
  • "material": {
    }
}

Create Part Attachments API

Add Attachments for a Part by ID or External ID

Authorizations:
apiKey
path Parameters
id
required
string

ID of the requested raw material. If the query parameter type is set to id than the internal UUID is used received by creation of the raw material. If query param is set to refid than the external reference ID string is used for the request that was given in the external Reference ID attribute.

Request Body schema: multipart/formdata
type
string
Enum: "id" "refid"

Identifies which type of ID is used in the query

attachments
string <binary>

One or more attachments for the Part. Allowed file types are STEP, STP, PNG, JPG, JPEG, PDF, STL.

Responses

Request samples 

curl --location --request POST 'https://api.up2parts.com/v1/part/13ef2181-9a19-40f6-b54a-1c2ee6dfc8d7/attachments'
            --header 'x-api-key: 123456abcdf78910stofi'
            --form 'attachments=@"/C:/Users/szignarovits/Downloads/ForPartAttachment.png"'
            --form 'attachments=@"/C:/Users/szignarovits/Downloads/ForPartAttachment2.png"' 
            --form 'type="id"'

Response samples

Content type
application/json
{
  • "id": "7636d2a8-f61f-406f-83cb-d445545b85de",
  • "name": "Milling Part",
  • "description": "string",
  • "tolerance": "ISO_2768-1_c",
  • "articleNumber": "Article1234",
  • "drawingNumber": 1234,
  • "indexStatus": "string",
  • "externalReferenceId": "ERP-1234",
  • "material": {
    }
}

Beta: Calculation

A calculation is mainly a work schedule in up2parts, but it also contains information about the part for which the calculation was created, the raw material selected, and the calculated prices.

Retrieve a calculation

Retrieves the details of an already created and saved calculation. Supply the internal ID of the calculation as a URL parameter that can be copied from the browser URL bar when it is opened for editing.

Authorizations:
apiKey
path Parameters
id
required
string <uuid>

Auto generated global unique id.

Responses

Response samples

Content type
application/json
{
  • "id": "711ded0b-0dcc-44e6-8c14-4d08e3e99f2e",
  • "part": {
    },
  • "rawPart": {
    },
  • "workSchedule": [
    ],
  • "graduatedCosts": [
    ],
  • "process": null,
  • "materialVariableCosts": 79.9,
  • "manufacturingVariableCosts": 20.84,
  • "manufacturingFixedCosts": 37.67
}

Create a calculation

Creates a new calculation.

Authorizations:
apiKey
Request Body schema: application/json
object
object

The piece of raw material that is used for manufacturing.

Array of objects

The list of work steps.

quantities
Array of numbers >= 1

The list of quantities.

process
string
Enum: "turning" "milling" "sheet"

Main process

Responses

Request samples

Content type
application/json
{
  • "part": {
    },
  • "rawPart": {
    },
  • "workSchedule": [
    ],
  • "quantities": [
    ],
  • "process": "turning"
}

Response samples

Content type
application/json
{
  • "id": "711ded0b-0dcc-44e6-8c14-4d08e3e99f2e",
  • "part": {
    },
  • "rawPart": {
    },
  • "workSchedule": [
    ],
  • "graduatedCosts": [
    ],
  • "process": null,
  • "materialVariableCosts": 79.9,
  • "manufacturingVariableCosts": 20.84,
  • "manufacturingFixedCosts": 37.67
}

Retrieve part calculation proposals

Retrieves the proposals of a calculation before actually creating calculation ordered by probability.

Authorizations:
apiKey
Request Body schema: application/json
idType
string
Default: "id"
Enum: "id" "refid"

ID of the requested part. If the body field idType is set to id (default if parameter is missing) than the internal UUID is used received by creation of the part. If body field is set to refid than the external reference ID string is used for the request that was given in the external Reference ID attribute.

partId
string

A internal or external PartId.

processes
Array of strings
Items Enum: "milling" "turning" "sheet"

Set a filter for the proposals you want

Responses

Request samples

Content type
application/json
{
  • "idType": "id",
  • "partId": "04242f00-6625-4e28-bc25-3cf19f426deb",
  • "processes": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Beta: Unit mapping

There are two unit systems available for tools: “metric” or “imperial”. Depending on the measurement unit, it will return the respective value for the parameters.

Important notes: 'Tools' is now only available as a Beta.

List of parameters with corresponding units:

Parameter Metric Imperial
edgeCount mm in
maximumRampingAngle ° °
chamferLength mm in
chamferAngle ° °
threadDiameter mm in
threadPitch mm in
cuttingDiameter mm in
outsideDiameter mm in
fluteLength mm in
shaftDiameter mm in
clearanceDiameter mm in
overallLength mm in
shoulderLength mm in
cornerRadius mm in
tipAngle ° °
taperAngle ° °
speed m/min ft/min
feedPerTooth mm/tooth in/tooth
feedPerRevolution mm/rev in/rev
spindleRevolution rpm rpm
feedRate mm/min in/min
toolOverhang mm in
height mm in
upperDiameter mm in
lowerDiameter mm in
maximumRadialDepthOfCut mm in
radialDepthOfCut mm in
maximumAxialDepthOfCut mm in
axialDepthOfCut mm in

Beta: Component

Components are used to manage cutting tool information in the up2parts cloud. Components are

  • Tool items

  • Adaptive items

according to the norm ISO 13399. The following interfaces are designed to create, update, delete and query tool item information in the up2parts cloud.

Important notes: Components are not ready to use for up2parts calculation and up2parts cloud basic customers yet, as it is now only available as a Beta.

List components

Returns all completed components (tool items or adaptive items) which are available from the system.

Authorizations:
apiKey
query Parameters
pageNumber
integer or null >= 1

Number of the page

pageSize
integer or null >= 1

Number of records per page

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

Create a component

Add a component to up2parts cloud.

Authorizations:
apiKey
Request Body schema: application/json
externalReferenceId
string or null [ 1 .. 64 ] characters

Identifier from the external system from where a component was synchronized to up2parts. It is unique within an account. If not “null”, it may neither be an empty string nor a string that only contains whitespace characters.

name
string <= 64 characters

Name for the component.

description
string or null <= 1024 characters

Description for component.

componentType
string
Enum: "tool_item" "adaptive_item"

A component type describes the general type of a component.

The value “tool_item” describes cutting tools like for example a solid endmill, whereas the value “adaptive_item” describes all adaptive elements like holders or adapters.

toolType
string or null
Enum: "flat_endmill" "bullnose_mill" "drill" "chamfer_mill" "reamer" "tap"

The parameter “toolType” describes general types of cutting tools.

measurementUnit
string or null
Enum: "metric" "imperial"

Unit of measurement. Required if toolType is selected.

Describes the unit system for the respective component.

object or null

Geometries and other parameters of component.

Array of objects or null

Cutting data values.

Responses

Request samples

Content type
application/json
{
  • "externalReferenceId": "TDM ID1",
  • "name": "Schaftfräser DC 10",
  • "description": "Serie HOLEX Pro INOX, Schneiden-⌀ DC 10 mm, Norm DIN 6527, Typ N",
  • "componentType": "tool_item",
  • "toolType": "flat_endmill",
  • "measurementUnit": "metric",
  • "toolParameters": {
    },
  • "cuttingData": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "e0ad0524-2d15-4e04-9a8a-8ae9e9805d5c",
  • "externalReferenceId": "TDM ID1",
  • "name": "Schaftfräser DC 10",
  • "description": "Serie HOLEX Pro INOX, Schneiden-⌀ DC 10 mm, Norm DIN 6527, Typ N",
  • "componentType": "tool_item",
  • "toolType": "flat_endmill",
  • "measurementUnit": "metric",
  • "toolParameters": {
    },
  • "cuttingData": [
    ]
}

Retrieve a component

Retrieves the details of a tool item or adaptive item. Supply the internal ID received by creation of the component or the external reference ID given in the created component request.

Authorizations:
apiKey
path Parameters
id
required
string

ID of the requested component. If the query parameter type is set to id (default if parameter is missing) than the internal UUID is used received by creation of the component. If query param is set to refid than the external reference ID string is used for the request that was given in the external Reference ID attribute.

query Parameters
type
string or null
Enum: "id" "refid"

Identifies which type of ID is used in the query.

Responses

Response samples

Content type
application/json
{
  • "id": "e0ad0524-2d15-4e04-9a8a-8ae9e9805d5c",
  • "externalReferenceId": "TDM ID1",
  • "name": "Schaftfräser DC 10",
  • "description": "Serie HOLEX Pro INOX, Schneiden-⌀ DC 10 mm, Norm DIN 6527, Typ N",
  • "componentType": "tool_item",
  • "toolType": "flat_endmill",
  • "measurementUnit": "metric",
  • "toolParameters": {
    },
  • "cuttingData": [
    ],
  • "isDraft": false
}

Delete a component

Delete a tool item or adaptive item from the list. Supply the internal ID received by creation of the component or the external reference ID given in the created component request.

Authorizations:
apiKey
path Parameters
id
required
string

ID of the requested component. If the query parameter type is set to id (default if parameter is missing) than the internal UUID is used received by creation of the component. If query param is set to refid than the external reference ID string is used for the request that was given in the external Reference ID attribute.

query Parameters
type
string or null
Enum: "id" "refid"

Identifies which type of ID is used in the query.

Responses

Beta: Assembly

Assembly is a combination of adaptive items and tool. Possible combinations can be:

Machine side
Tool item Adaptive item Assembly item
Workpiece side Cutting item X X
Tool item X X X
Adaptive item X X
Assembly item X X X

The following interface is designed to create an assembly in the up2parts cloud.

Important notes: Assembly is now only available as a Beta.

Create an Assembly

Add an assembly to up2parts cloud.

Authorizations:
apiKey
Request Body schema: application/json
externalReferenceId
string or null [ 1 .. 64 ] characters

Identifier from the external system from where an assembly was synchronized to up2parts. It is unique within an account. If not “null”, it may neither be an empty string nor a string that only contains whitespace characters.

name
string <= 64 characters

Name of an assembly.

description
string or null <= 1024 characters

Description of an assembly.

measurementUnit
string
Enum: "metric" "imperial"

Unit of measurement. Required.

Describes the unit system for the respective component. Refer to Unit mapping.

object

Associated tool which forms an assembly.

Array of objects

Associated adaptive items which form an assembly.

Responses

Request samples

Content type
application/json
{
  • "externalReferenceId": "123",
  • "name": "Gesamtwerkzeug Schaftfräser Hoffmann, HSKA63",
  • "description": "Schaftfräser DC 10 und Flächenspannfutter HSK-A-32 D=6 mm",
  • "measurementUnit": "metric",
  • "tool": {
    },
  • "adaptiveItems": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "e0ad0524-2d15-4e04-9a8a-8ae9e9805d5c",
  • "externalReferenceId": "123",
  • "name": "Gesamtwerkzeug Schaftfräser Hoffmann, HSKA63",
  • "description": "Schaftfräser DC 10 und Flächenspannfutter HSK-A-32 D=6 mm",
  • "measurementUnit": "metric",
  • "tool": {
    },
  • "adaptiveItems": [
    ]
}