Component Data¶

GetComponentParameters¶

Retrieve parameters for a component from the ERP/PDM system.

When is this called?

Called when inserting/configuring components and before output.

Capability: getComponentParameters

Request¶

Field	Type	Required	Description
`articleCode`	`string`	✅	Article code identifying the component.
`projectId`	`string`		Current project context, if relevant.

Response¶

Field	Type	Required	Description
`articleCode`	`string`	✅	Echo of the requested article code.
`status`	`string`	✅	Component status: released, draft, obsolete, blocked.
`description`	`string`		Human-readable description.
`price`	`number`		Unit price.
`currency`	`string`		ISO 4217 currency code.
`manufacturer`	`string`		Manufacturer name.
`manufacturerPartNo`	`string`		Manufacturer's own part number.
`leadTimeDays`	`integer`		Lead time in days.
`stock`	`integer`		Current stock quantity.
`properties`	`map`		Arbitrary additional properties.

Example¶

Request

```json { "method": "GetComponentParameters", "request": {

"articleCode": "HV-301", "projectId": "PRJ-2025-0042" } } ```

Response

```json { "result": "OK", "response": {

"articleCode": "HV-301", "status": "released", "description": "Directional valve 4/3, 24V DC", "price": 1250.00, "currency": "EUR", "manufacturer": "Bosch Rexroth", "manufacturerPartNo": "R900052271", "leadTimeDays": 14, "stock": 42, "properties": {"key": "value"} } } ```

C# Override¶

public override GetComponentParametersResponse GetComponentParameters(GetComponentParametersRequest request)
{
        // return new GetComponentParametersResponse { ArticleCode = ... };
    throw new NotImplementedException();
}

JSON Schemas: Request · Response

GetPartFamilyMembers¶

List all members of a part family.

Capability: getPartFamilyMembers

Request¶

Field	Type	Required	Description
`parentId`	`string`	✅	Identifier of the parent/family.
`parentCode`	`string`		Article code of the parent, if separate.

Response¶

Field	Type	Required	Description
`members`	`array<PartFamilyMember>`	✅	List of family members.

Example¶

Request

```json { "method": "GetPartFamilyMembers", "request": {

"parentId": "FAM-HV300", "parentCode": "HV-300-SERIES" } } ```

Response

```json { "result": "OK", "response": {

"members": [/ PartFamilyMember /] } } ```

C# Override¶

public override GetPartFamilyMembersResponse GetPartFamilyMembers(GetPartFamilyMembersRequest request)
{
        // return new GetPartFamilyMembersResponse { Members = ... };
    throw new NotImplementedException();
}

JSON Schemas: Request · Response