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

Retrieve the full list of parts

POST
https://mcs-gateway.fscut.com/cn-api/api/part/list/v2
Parameter Description：#
{
	"method": "filter",
	"searchString": "", // Name search, currently supports part name
	"filterInfo": [ // Filter conditions
		{
			"region": "create_at", // Creation date filter
			"name": "customDate", // today - today, yesterday - yesterday, lastWeek - past week, lastMonth - past month, customDate - custom date range
			"startDate": "2020-10-01", // Used when name == 'customDate'
			"endDate": "2020-10-31" // Used when name == 'customDate'
		},
		{
			"region": "status", // Status filter
			"name": "uncompleted" // uncompleted - finished, completed - not finished
		},
		{
			"region": "material", // Material filter
			"name": "Cold Rolled Steel"
		},
		{
			"region": "thickness", // Thickness filter
			"name": "1.0"
		},
		{
			"region": "gas", // Gas filter
			"name": "Air"
		}
	],
	"job_id": [1870, 1826], // Job filter, parameter is a list of job IDs
	"pageNum": 1, // Pagination, default is the first page
	"pageSize": 100, // Pagination, items per page, default is 100
	"with_prop": 0 // with_prop == 1 returns part properties
}

Request

Authorization
Header Params

Body Params application/json

Example
{
    "method": "string",
    "searchString": "string",
    "filterInfo": [
        {
            "region": "string",
            "name": "string",
            "startDate": "string",
            "endDate": "string"
        }
    ],
    "job_id": [
        0
    ],
    "pageNum": 0,
    "pageSize": 0
}

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/list/v2' \
--header 'appId: op191eb50f9b81873c' \
--header 'appSecret: appSecret' \
--header 'timestamp: 1743497261540' \
--header 'appSign: 13622d51e3e4f4935c8ba27728ed309f' \
--header 'X-FS-Orgcode: TEAM001' \
--header 'Content-Type: application/json' \
--data '{
    "method": "string",
    "searchString": "string",
    "filterInfo": [
        {
            "region": "string",
            "name": "string",
            "startDate": "string",
            "endDate": "string"
        }
    ],
    "job_id": [
        0
    ],
    "pageNum": 0,
    "pageSize": 0
}'

Responses

🟢200成功
application/json
Bodyapplication/json

Example
{
  "data": [
    {
      // Unique identifier for the part
      "guid": "90FD531C-4B1A-48D1-B777-2FD404970363",
      // Part name
      "part_name": "(Cutting Drawing 454) 65EA3bC3",
      // Material
      "material": "Q235",
      // Thickness
      "thickness": 0.8,
      // Gas
      "gas": "N2",
      // Quantity
      "amount": 10,
      // In-nest quantity
      "in_nest_amount": 0,
      // Un-nest quantity
      "un_nest_amount": 10,
      // Finished nest quantity
      "finish_nest_amount": 0,
      // In-cut quantity
      "in_cut_amount": 0,
      // To-be-cut quantity
      "un_cut_amount": 0,
      // Finished cut quantity
      "finish_cut_amount": 0,
      // Dimensions - Width
      "width": 670,
      // Dimensions - Height
      "height": 437,
      // Associated job ID
      "job_id": 1870,
      // Job title
      "job_title": "02",
      // Part file name
      "partfile_path": "20210315_153103_784946823J.prts",
      // Part download link
      "partfile_url": "http://raymes.oss-cn-shanghai.aliyuncs.com/saas-resource/corp-prts/CorpID1001/20210315/20210315_153103_784946823J.prts?OSSAccessKeyId=LTAIwvoiFSZhjvAB&Expires=1615888553&Signature=uib0Sh9U0z2H76mPQyUyZUWSgP4%3D",
      // Thumbnail file name
      "thumbnail_path": "20210315_153103_784946823J.png",
      // Thumbnail download link
      "thumbnail_url": "http://raymes.oss-cn-shanghai.aliyuncs.com/saas-resource/corp-prts/CorpID1001/20210315/20210315_153103_784946823J.png?OSSAccessKeyId=LTAIwvoiFSZhjvAB&Expires=1615888553&Signature=ewVKvmpCtQ5LTXg7jZqAft0ST1g%3D",
      "create_by": 1670,
      "update_by": null
    }
  ],
  "msg": "OK",
  "page_num": 1,
  "page_size": 100,
  "status": 0,
  "total": 84
}
Modified at 2025-04-01 09:41:41
Previous
Generate parts (SmartDraw)
Next
Retrieve the list of parts on the layout (returned in order of their physical positions)
Built with