1. part
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
  1. part

Generate parts (JS template)

POST
https://mcs-gateway.fscut.com/cn-api/api/part/js2part
Explanation of the data parameter:
[
  {
    "datas": {
      "argument": { // JavaScript parameters
        "Height": 1000
      },
      "part_name": "201109-01", // Part name
      "material": "Cold Rolled Steel", // Part material
      "thickness": 1.0, // Part thickness
      "gas": "Air", // Gas used for the part
      "amount": 1, // Quantity of parts
      "rotate_lock": 0, // Rotation lock: rotate_lock=1 locks rotation, default is 0
      "fill_color": "800000", // Fill color of the part
      "prop": { // Part properties
        "Order Number": "1027594022", // Property-value pairs
        "Material Number": "277516275",
        "Other": "1",
        "Location.X": 8,
        "Location.Y": 10
      }
    },
    "filename": "L-shaped Bracket.js", // Corresponding JavaScript file name
    "jobId": 1606 // ID of the job to which it needs to be uploaded
  },
  ...
]

Request

Authorization
Header Params

Body Params multipart/form-data

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://mcs-gateway.fscut.com/cn-api/api/part/js2part' \
--header 'appId: op191eb50f9b81873c' \
--header 'appSecret: appSecret' \
--header 'timestamp: 1743497261540' \
--header 'appSign: 13622d51e3e4f4935c8ba27728ed309f' \
--header 'X-FS-Orgcode: TEAM001' \
--form 'files=@"C:\\Program Files\\Friendess\\CypNest\\ScriptShapes\\L型支架.js"' \
--form 'files=@"C:\\Program Files\\Friendess\\CypNest\\ScriptShapes\\边角开口的矩形.js"' \
--form 'data="[    {        \"datas\":        {            \"argument\":            {                \"Height\": 1000            },            \"part_name\": \"210507-01\",            \"material\": \"冷轧板\",            \"thickness\": 1.0,            \"gas\": \"Air\",            \"amount\": 1,            \"fill_color\": \"800000\",            \"prop\":            {                \"订单号\": \"1027594022\",                \"物料号\": \"277516275\",                \"其他\": \"1\",                \"Location.X\": 8,                \"Location.Y\": 10            }        },        \"filename\": \"L型支架.js\",        \"jobId\": 7036    },    {        \"datas\":        {            \"argument\":            {                \"CornerX\": 10,                \"Height\": 100            },            \"part_name\": \"210507-02\",            \"material\": \"不锈钢\",            \"thickness\": 1.2,            \"gas\": \"H-N2\",            \"amount\": 1,            \"rotate_lock\": 0,            \"fill_color\": \"00CC00\",            \"prop\":            {                \"订单号\": \"1027593849\",                \"物料号\": \"277508913\",                \"其他\": \"2\"            }        },        \"filename\": \"边角开口的矩形.js\",        \"jobId\": 7036    },    {        \"datas\":        {            \"argument\":            {                \"CornerX\": 20,                \"Height\": 200            },            \"part_name\": \"210507-03\",            \"material\": \"不锈钢\",            \"thickness\": 1.2,            \"gas\": \"H-N2\",            \"amount\": 2,            \"rotate_lock\": 1,            \"fill_color\": \"00CCFF\",            \"prop\":            {                \"订单号\": \"1027594019\",                \"物料号\": \"277516266\",                \"其他\": \"3\"            }        },        \"filename\": \"边角开口的矩形.js\",        \"jobId\": 7036    }]"'

Responses

🟢200成功
application/json
Bodyapplication/json

Example
{
    "status": 0,
    "msg": "OK",
    "data": [
        {
            "datas": {
                "amount": 1,
                "argument": {
                    "Height": 1000
                },
                "gas": "Air",
                "guid": "64171B72-43A5-4431-9035-23EC56CC9D70",
                "material": "冷轧板",
                "part_name": "210507-01",
                "prop": {
                    "其他": "1",
                    "物料号": "277516275",
                    "订单号": "1027594022"
                },
                "thickness": 1
            },
            "filename": "L型支架.js",
            "jobId": 2199
        },
        {
            "datas": {
                "amount": 1,
                "argument": {
                    "CornerX": 10,
                    "Height": 100
                },
                "gas": "H-N2",
                "guid": "59784875-8AD1-4C73-BD23-29B2C907A045",
                "material": "不锈钢",
                "part_name": "210507-02",
                "prop": {
                    "其他": "2",
                    "物料号": "277508913",
                    "订单号": "1027593849",
                    "Location.X": 8,
                    "Location.Y": 10
                },
                "rotate_lock": 0,
                "thickness": 1.2
            },
            "filename": "边角开口的矩形.js",
            "jobId": 2199
        },
        {
            "datas": {
                "amount": 2,
                "argument": {
                    "CornerX": 20,
                    "Height": 200
                },
                "gas": "H-N2",
                "guid": "6C848486-8797-4BAB-8AE3-BC24B0204DF8",
                "material": "不锈钢",
                "part_name": "210507-03",
                "prop": {
                    "其他": "3",
                    "物料号": "277516266",
                    "订单号": "1027594019"
                },
                "rotate_lock": 1,
                "thickness": 1.2
            },
            "filename": "边角开口的矩形.js",
            "jobId": 2199
        }
    ]
}
Modified at 2025-04-01 09:41:41
Previous
Generate parts (imported from nc1)
Next
Generate parts (DXF file)
Built with