needAuth/Product

---

Create Product

POST

/product/create

The route to upload a new product in database and on the FTP

Authorizations

bearer

Type

HTTP (bearer)

Request Body

application/json

{

"name": "test",

"reference": "AA001",

"stageGraph": [

{

"id": "1",

"name": "import_cao",

"dependencies": [

]

},

{

"id": "2",

"name": "cad_convertion",

"dependencies": [

"1"

]

},

{

"id": "3",

"name": "cad_segmentation",

"dependencies": [

"1"

]

},

{

"id": "4",

"name": "model_target",

"dependencies": [

"2"

]

}

]

}

Responses

Content-Type

application/json

{

}

POST

/product/create

Playground

Server

Authorization

bearer

Body

Samples

---

Get product by id

GET

/product/{id}

The route to get a product

Authorizations

bearer

Type

HTTP (bearer)

Parameters

Path Parameters

id*

Type

string

Required

Example""

Responses

Content-Type

application/json

{

"product": "string",

"stageGraph": [

]

}

GET

/product/{id}

Playground

Server

Authorization

bearer

Variables

Key

Value

id*

Samples

---

Upload file for product

POST

/product/upload

The endpoint to upload a file

Authorizations

bearer

Type

HTTP (bearer)

Request Body

multipart/form-data

object

Format"binary"

The path to the FTP

The reference of the product

Responses

Content-Type

application/json

{

}

POST

/product/upload

Playground

Server

Authorization

bearer

Body

product*

filePath*

reference*

Samples

---

Get list of products ready to scan

GET

/product/scannable-list

This endpoint is used to get a list of the products that have parts ready to scan, alongside the filepath to get the model target.

Authorizations

bearer

Type

HTTP (bearer)

Parameters

Header Parameters

Authorization

Type

string

Example""

Responses

Content-Type

application/json

[

{

"id": "string",

"reference": "string",

"name": "string",

"parts": [

{

"id": "string",

"reference": "string"

}

]

}

]

GET

/product/scannable-list

Playground

Server

Authorization

bearer

Headers

Authorization

Samples

---

Delete product

DELETE

/product/{productId}

The endpoint to delete a product. It also deletes the file in the FTP linked to the product

Authorizations

bearer

Type

HTTP (bearer)

Parameters

Path Parameters

productId*

Type

string

Required

Responses

Content-Type

application/json

{

}

DELETE

/product/{productId}

Playground

Server

Authorization

bearer

Variables

Key

Value

productId*

Samples

---