Zum Hauptinhalt springen
GET
/
projects
/
{id}
/
components
Projektkomponenten abrufen
curl --request GET \
  --url https://api.comstruct.com/v1/projects/{id}/components \
  --header 'X-API-Key: <api-key>'
{
  "components": [
    {
      "id": 123,
      "title": "<string>",
      "type_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "project_component_type": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "title": "<string>",
        "order": 123,
        "enable_in_deliveries": true,
        "enable_in_orders": true
      }
    }
  ]
}

​
Übersicht

Listet alle Projektkomponenten eines Projekts mit zugehörigem Komponententyp. Diese IDs (id) verwenden Sie z. B. im Body von PUT /deliveries/{id}/components (component_ids).

​
Berechtigungen

ScopeBeschreibung
projects:readProjektdaten lesen

​
Verhalten

Wenn das Projekt nicht existiert oder nicht zum Mandanten des API-Schlüssels gehört, liefert die API { "components": [] } mit HTTP 200 — kein 404.

​
Response Codes

CodeBeschreibung
200Erfolg (ggf. leere components)
401Nicht autorisiert
403Verboten

Autorisierungen

​
X-API-Key
string
header
erforderlich

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.

Pfadparameter

​
id
string<uuid>
erforderlich

Projekt-ID (UUID)

Antwort

Liste der Projektkomponenten

​
components
object[]
erforderlich

Alle Komponenten des Projekts (leer, wenn nicht sichtbar oder nicht vorhanden)