curl --request POST \
  --url https://api.comstruct.com/v1/projects \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "title": "Highway Construction Project",
  "project_number": "HCP-2024-001",
  "external_id": "EXT-2024-001",
  "description": "Construction of highway section A1-A2",
  "region": "Bavaria",
  "active": true
}
'

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "external_id": "EXT-001",
  "title": "Example Site",
  "project_number": "23423420",
  "description": "<string>",
  "region": "Bavaria",
  "project_region_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "active": true,
  "status": "<string>",
  "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "address": {
    "address": "<string>",
    "city": "<string>",
    "zip": "<string>"
  },
  "project_invites": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "email": "jsmith@example.com",
      "role": "<string>",
      "role_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "tenant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ]
}

Projects

Create project

Erforderliche Berechtigungen: projects:write, users:read, roles:read, tenant_settings:read

Erstellt ein neues Projekt oder aktualisiert ein bestehendes Projekt. Dieser Endpunkt führt eine Upsert-Operation basierend auf dem external_id-Feld (falls vorhanden) oder der project_number durch.

Hauptfunktionen:

Upsert-Logik: Wenn external_id angegeben ist und ein Projekt mit dieser ID existiert, wird es aktualisiert. Andernfalls wird project_number für den Abgleich verwendet. Wenn keine Übereinstimmung gefunden wird, wird ein neues Projekt erstellt.
Benutzerverwaltung: Behandelt automatisch Benutzereinladungen und Rollenzuweisungen für Projektteammitglieder.
Regionszuordnung: Das region-Feld kann verwendet werden, um das Projekt einer Projektregion zuzuordnen.
Buchungskreis-Zuordnung: Das legal_entity_number-Feld kann verwendet werden, um das Projekt einem Buchungskreis zuzuordnen.
Validierung: Alle erforderlichen Felder (title, project_number) werden vor der Verarbeitung validiert.

Best Practices:

Geben Sie external_id für zuverlässige Upsert-Operationen an
Verwenden Sie region oder project_region_id für die Projektregionszuordnung
Verwenden Sie legal_entity_number oder legal_entity_id für die Buchungskreis-Zuordnung
Fügen Sie vollständige Adressinformationen hinzu, wenn verfügbar, für besseres Projektmanagement
Stellen Sie sicher, dass Rollennamen in project_invites mit bestehenden Rollen in Ihrem Mandanten übereinstimmen

POST

projects

curl --request POST \
  --url https://api.comstruct.com/v1/projects \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "title": "Highway Construction Project",
  "project_number": "HCP-2024-001",
  "external_id": "EXT-2024-001",
  "description": "Construction of highway section A1-A2",
  "region": "Bavaria",
  "active": true
}
'

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "external_id": "EXT-001",
  "title": "Example Site",
  "project_number": "23423420",
  "description": "<string>",
  "region": "Bavaria",
  "project_region_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "active": true,
  "status": "<string>",
  "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "address": {
    "address": "<string>",
    "city": "<string>",
    "zip": "<string>"
  },
  "project_invites": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "email": "jsmith@example.com",
      "role": "<string>",
      "role_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "tenant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ]
}

Authorizations

X-API-Key

string

header

required

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.

Body

application/json

title

string

required

Der Titel des Projekts

Example:

"Example Site"

project_number

string

required

Die Projektnummer (erforderlich)

Example:

"23423420"

external_id

string

Die externe Kennung des Projekts. Muss innerhalb des Kunden eindeutig sein. Wird für Upsert-Operationen verwendet.

Example:

"EXT-001"

description

string

Eine Beschreibung des Projekts

region

string

Die Regionsnummer, in der sich das Projekt befindet, wird für Filterung und Projektregionssuche verwendet

Example:

"Bavaria"

project_region_id

string<uuid>

Direkte Referenz auf eine Projektregions-ID (Alternative zur Regionssuche)

legal_entity_id

string<uuid>

Direkte Referenz auf eine Buchungskreis-ID

legal_entity_number

string

Buchungskreisnummer zum Nachschlagen und Verknüpfen des Buchungskreises

alternative_project_number

string

Alternative Projektnummer zur Referenz

active

boolean

Steuert, ob das Projekt aktiv ist

address

object

Die Adressdetails des Projekts

Show child attributes

project_invites

object[]

Benutzereinladungen für das Projekt

Show child attributes

Response

Projekt erfolgreich erstellt oder aktualisiert

string<uuid>

Die eindeutige Kennung des Projekts

external_id

string

Die externe Kennung des Projekts

Example:

"EXT-001"

title

string

Der Titel des Projekts

Example:

"Example Site"

project_number

string | null

Die Projektnummer

Example:

"23423420"

description

string

Eine Beschreibung des Projekts

region

string

Die Region, in der sich das Projekt befindet, wird für Filterung verwendet

Example:

"Bavaria"

project_region_id

string<uuid> | null

Die ID der verknüpften Projektregion

active

boolean | null

Steuert, ob das Projekt aktiv ist

status

string

Der Status des Projekts

customer_id

string<uuid>

Die eindeutige Kennung des Kunden

address

object

Die Adressdetails des Projekts

Show child attributes

project_invites

object[]

Dem Projekt zugewiesene Benutzereinladungen

Show child attributes

List projects Get project by external ID

Documentation Index

Authorizations

Body

Response