needAuth/Part

---

Create Part

POST

/part/create

This route is used to create a part

Authorizations

bearer

Type

HTTP (bearer)

Request Body

application/json

{

"productRef": "string",

"reference": "string",

"stageList": "string"

}

Responses

Content-Type

application/json

{

}

POST

/part/create

Playground

Server

Authorization

bearer

Body

Samples

---

Get part by reference

GET

/part/{id}

The route is used to get a part data

Authorizations

bearer

Type

HTTP (bearer)

Parameters

Path Parameters

id*

Type

string

Required

Responses

Content-Type

application/json

{

"part": "string",

"stageGraph": [

]

}

GET

/part/{id}

Playground

Server

Authorization

bearer

Variables

Key

Value

id*

Samples

---

Get list of parts

GET

/part/list

This endpoint is used to get a list of reference of parts, paginated.

Authorizations

bearer

Type

HTTP (bearer)

Parameters

Header Parameters

Authorization

Type

string

Example""

Query Parameters

limit

Type

number

Default

25

refQuery

Type

string

page

Type

number

Default

1

Responses

Content-Type

application/json

{

}

GET

/part/list

Playground

Server

Authorization

bearer

Headers

Authorization

Variables

Key

Value

limit

refQuery

page

Samples

---

Get all part waiting for scan

GET

/part/waiting-scan

This endpoint is used to get all the parts that are waiting for a scan, with their files url.

Authorizations

bearer

Type

HTTP (bearer)

Responses

Content-Type

application/json

[

{

"id": "string",

"reference": "string",

"product": {

"id": "string",

"reference": "string",

"name": "string"

}

}

]

GET

/part/waiting-scan

Playground

Server

Authorization

bearer

Samples

---

Powered by VitePress OpenAPI