Preliminary preparation
Copy Page
CloudNest Open Platform API Documentation
Preliminary preparation
0. Introduction
a. Use our demo to quickly generate request headers
b. Manually create the request header
1. API Quota & API Rate Limit
2. Data Dictionary
part
Generate parts (imported from nc1)
POST
Generate parts (JS template)
POST
Generate parts (DXF file)
POST
Generate parts (SmartDraw)
POST
Retrieve the full list of parts
POST
Retrieve the list of parts on the layout (returned in order of their physical positions)
POST
Copy parts
POST
Update and delete part information
POST
Update the custom properties of a part
POST
plate
Retrieve scrap sheet hierarchy details
GET
Add plate
POST
Retrieve plate list
POST
Update plate information
POST
drawing
Query drawing information
POST
Upload DXF drawing to the job (upload file).
POST
Upload dxf drawings to the job (active download)
POST
Delete DXF drawing (force delete)
POST
Delete DXF drawing (cannot be deleted if processed or being processed)
POST
material
Add Material
POST
Get Material List
GET
job
Query job information by job ID
Add Job
Get Job List
Get Parts List under the Job
Get Layout List under the Job
Get the formatting details of the assignment
Get the production schedule list of the assignment
Get the part layout information under the assignment
Get the list of plates used in the assignment
Get the production task details under the assignment
Search the assignment (exact search by assignment name)
Delete job
Query the drawing processing status under the specified job
Get the nesting details under the job (return the DXF download link of the nesting and the part serial numbers)
Boost
Query job information by job ID (flat view)
Delete nesting
production
Query completed task list for the machine tool
Get production task details
Server-side - Push the layout to the CNC machine
Part Text Recognition
Get user-defined text recognition configuration
Drawing processing text recognition configuration
others
Get job and material information based on the layout GUID
Get the parts list based on the layout GUID
Preliminary preparation
Copy Page
2. Data Dictionary
Gas Types
#
Below is a list of gas types with their corresponding descriptions:
Gas Type
Description
Air
Air (空气)
O2
Oxygen (氧气)
N2
Nitrogen (氮气)
H-Air
High-pressure Air (高压空气)
H-O2
High-pressure Oxygen (高压氧气)
H-N2
High-pressure Nitrogen (高压氮气)
Modified at
2025-04-02 01:12:10
Previous
1. API Quota & API Rate Limit
Next
Generate parts (imported from nc1)