Appearance
Servers
http://localhost:3000Local tests
http://192.168.0.103:3000Develop Env
Create one
POST
/user/create
This route is used to create a new user
Authorizations
bearer
Type
HTTP (bearer)
Parameters
Header Parameters
Authorization*
The jwt token created upon login
Type
Requiredstring
Example
"Bearer jwtToken"Request Body
application/json
JSON
{
"email": "informatique@polyflyx.com",
"username": "user-1768",
"firstname": "Thomas",
"lastname": "Samot",
"password": "123456",
"roleIds": [
],
"rightIds": [
]
}
Responses
application/json
JSON
{
}
Get user by id
GET
/user/{id}
Authorizations
bearer
Type
HTTP (bearer)
Parameters
Path Parameters
id*
The id of the user you're looking for
Type
Requiredstring
Example
"{{$number.int(min=1)}}"Responses
application/json
JSON
{
"email": "informatique@polyflyx.com",
"username": "user-1768",
"firstname": "Thomas",
"lastname": "Samot",
"roles": [
],
"rights": [
]
}
Update one
PATCH
/user/{id}
This route is used to update a user
Authorizations
bearer
Type
HTTP (bearer)
Parameters
Header Parameters
Authorization*
The jwt token created upon login
Type
Requiredstring
Example
"Bearer jwtToken"Path Parameters
id*
The id of the user you want to update
Type
Requiredstring
Request Body
application/json
JSON
{
"email": "informatique@polyflyx.com",
"username": "user-1768",
"firstname": "Thomas",
"lastname": "Samot",
"password": "123456",
"roleIds": [
],
"rightIds": [
]
}
Responses
application/json
JSON
{
}
Add role
Add right
POST
/user/{id}/right
This route is used to add rights to a user
Authorizations
bearer
Type
HTTP (bearer)
Parameters
Path Parameters
id*
The id of the user you want to add rights to
Type
Requiredinteger
Example
"{{$number.int(min=1)}}"Request Body
application/json
JSON
{
"rightIds": [
0
]
}
Responses
application/json
JSON
{
}
Remove right
Create one role
Delete one role
Get all roles
Get all roles tree
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
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
application/json
JSON
{
}
Get product by id
Upload file for product
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
application/json
JSON
[
{
"id": "string",
"reference": "string",
"name": "string",
"parts": [
{
"id": "string",
"reference": "string"
}
]
}
]