GET /serial-hierarchy

Get Serial Hierarchy

GET

/serial-hierarchy

Get the serial hierarchy, from the root ancestor (the one with no parent) to all descendants of the given serial.

Resolves the root ancestor of serial_key using GET_SERIAL_ROOT_ANCESTOR,
then builds a full recursive SerialTreeNode tree by walking the contains
edge collection downward. Returns a list containing the single root node with
all descendants nested under children.

Emits: (direct query — no event class)
Required scope: serial:read

Authorizations

OAuth2PasswordBearer

password Flow

Token URL"/api/auth"

Scopes:

• "admin"User can access and edit users and system settings
• "library"User can access and edit products
• "production"User can access and edit production plans
• "operator"User can access the operator panel and make production declarations

Parameters

Query Parameters

serial_key*

Type

string

Required

include_expected_components

Type

boolean

Default

true

Responses

Successful Response

Content-Type

application/json

[

  

{

  

  

"serial_key": "SN-LR-001234",

  

  

"product_key": "67890",

  

  

"serial_code": "SN-LR-001234",

  

  

"product_code": "PROD-001",

  

  

"replaced": false,

  

  

"confirmed": true,

  

  

"extra_bom": false,

  

  

"product_description": "Steel bracket M6",

  

  

"children": [

  

  

  

{

  

  

  

}

  

  

]

  

}

]

Samples

Powered by VitePress OpenAPI