curl --request PUT \
--url https://api.comstruct.com/v1/deliveries/{id}/components \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"groups": [
{
"component_ids": [
42,
17
],
"distribution": {
"Beton C30/37": 5.5,
"Betonpumpe": 1
}
},
{
"component_ids": [
99
],
"distribution": {
"Beton C25/30": 3
}
}
]
}
'{
"groups": [
{
"group_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"distribution": {
"Beton C30/37": 5.5
},
"components": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"component_id": 123,
"component_title": "<string>",
"component_type_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"component_type_title": "<string>"
}
]
}
]
}Replace delivery components
Erforderliche Berechtigungen: deliveries:patch
Ersetzt alle Komponentenzuordnungen der Lieferung durch die übergebenen Gruppen.
Alle component_ids müssen zum Projekt der Lieferung gehören; innerhalb einer Gruppe müssen sie eindeutig sein.
Verteilungswerte müssen endliche, nicht negative Zahlen sein.
Gruppen, deren distribution leer ist oder nur Nullen enthält, werden ignoriert (wie in der Web-App).
Mit einem leeren Array groups werden alle Zuordnungen entfernt.
curl --request PUT \
--url https://api.comstruct.com/v1/deliveries/{id}/components \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"groups": [
{
"component_ids": [
42,
17
],
"distribution": {
"Beton C30/37": 5.5,
"Betonpumpe": 1
}
},
{
"component_ids": [
99
],
"distribution": {
"Beton C25/30": 3
}
}
]
}
'{
"groups": [
{
"group_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"distribution": {
"Beton C30/37": 5.5
},
"components": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"component_id": 123,
"component_title": "<string>",
"component_type_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"component_type_title": "<string>"
}
]
}
]
}Overview
Replaces all component assignments for the delivery with the provided groups — equivalent to saving the component overview in the web app. Each group typically combines several project components (often one per component type) that share the same quantity split across delivery line items.Permissions
| Scope | Tenant type |
|---|---|
deliveries:patch | Customer only (CUSTOMER_ONLY) |
Request body
| Field | Type | Description |
|---|---|---|
groups | array | List of groups; [] clears all assignments |
Per group (groups[])
| Field | Type | Description |
|---|---|---|
component_ids | number[] | Project component IDs; at least one per group, unique within the group |
distribution | object | Map from delivery line item title (title on the line item) to a finite non-negative quantity |
Validation and behavior
- Every
component_idmust belong to the delivery’s project. - Distribution values must be finite, non-negative numbers.
- Groups whose
distributionis empty or contains only zeros are skipped (same as the web app). - The response matches GET
/deliveries/{id}/components(including server-assignedgroup_idand enriched component metadata).
Response codes
| Code | Description |
|---|---|
200 | Components saved; body same shape as GET |
400 | Invalid body or components not on the delivery’s project |
403 | Forbidden — delivery belongs to another customer |
404 | Delivery not found |
Authorizations
API-Schlüssel zur Authentifizierung. Kontaktieren Sie Ihren Customer Success Manager, um einen API-Schlüssel zu erhalten.
Jeder Endpunkt erfordert spezifische Berechtigungen (Scopes); die erforderlichen Scopes werden pro Endpunkt angezeigt.
Scopes
Path Parameters
Lieferungs-ID (UUID)
Body
Liste der Komponentengruppen; leeres Array entfernt alle Zuordnungen
Show child attributes
Show child attributes
Response
Komponentengruppen nach der Aktualisierung (gleiche Struktur wie GET)
Show child attributes
Show child attributes