curl --request POST \
  --url https://api.comstruct.com/v1/projects/sap \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
[
  {
    "number": "PRJ-2024-001",
    "title": "Highway Construction A1",
    "type": "Infrastructure",
    "parent_number": "Bavaria",
    "legal_entity_number": "LE-001",
    "alternative_number": "ALT-PRJ-001"
  }
]
'

[
  {
    "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,
    "alternative_project_number": "<string>",
    "status": "<string>",
    "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "address": {
      "address": "<string>",
      "city": "<string>",
      "country": "<string>",
      "house_number": "<string>",
      "zip": "<string>"
    },
    "legal_entity": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "title": "<string>",
      "number": "<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"
      }
    ]
  }
]

Projekte

SAP-Projekte erstellen

Erforderliche Berechtigungen: projects:write

Empfängt und verarbeitet Projekte aus dem SAP-System. Akzeptiert ein Array von SAP-Projekten.

Feldzuordnung:

number → project_number: Die SAP-Projektnummer
title → title: Der Projekttitel
type → description: Der Projekttyp/die Beschreibung
parent_number → region: Wird für die Projektregionssuche verwendet
legal_entity_number: Wird für die Buchungskreis-Zuordnung verwendet
alternative_number → alternative_project_number: Die alternative Projektnummer in SAP

POST

projects

sap

curl --request POST \
  --url https://api.comstruct.com/v1/projects/sap \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
[
  {
    "number": "PRJ-2024-001",
    "title": "Highway Construction A1",
    "type": "Infrastructure",
    "parent_number": "Bavaria",
    "legal_entity_number": "LE-001",
    "alternative_number": "ALT-PRJ-001"
  }
]
'

[
  {
    "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,
    "alternative_project_number": "<string>",
    "status": "<string>",
    "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "address": {
      "address": "<string>",
      "city": "<string>",
      "country": "<string>",
      "house_number": "<string>",
      "zip": "<string>"
    },
    "legal_entity": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "title": "<string>",
      "number": "<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"
      }
    ]
  }
]

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.

Body

application/json

number

string

erforderlich

SAP-Projektnummer (wird zu project_number zugeordnet)

Beispiel:

"PRJ-2024-001"

title

string

erforderlich

Projekttitel

Beispiel:

"Highway Construction A1"

type

string

erforderlich

Projekttyp (wird zu description zugeordnet)

Beispiel:

"Infrastructure"

parent_number

string

Übergeordnete Nummer für Regionssuche (wird zu region zugeordnet)

Beispiel:

"Bavaria"

legal_entity_number

string

Buchungskreis / Gesellschaftsnummer

Beispiel:

"LE-001"

alternative_number

string

Alternative Projektnummer in SAP (wird zu alternative_project_number zugeordnet)

Beispiel:

"ALT-PRJ-001"

Antwort

Projekte erfolgreich erstellt

string<uuid>

Die eindeutige Kennung des Projekts

external_id

string

Die externe Kennung des Projekts

Beispiel:

"EXT-001"

title

string

Der Titel des Projekts

Beispiel:

"Example Site"

project_number

string | null

Die Projektnummer

Beispiel:

"23423420"

description

string

Eine Beschreibung des Projekts

region

string

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

Beispiel:

"Bavaria"

project_region_id

string<uuid> | null

Die ID der verknüpften Projektregion

active

boolean | null

Steuert, ob das Projekt aktiv ist

alternative_project_number

string | null

Alternative Projektnummer zur Referenz, z. B. aus SAP

status

string

Der Status des Projekts

customer_id

string<uuid>

Die eindeutige Kennung des Kunden

address

object

Die Adressdetails des Projekts

Show child attributes

legal_entity

object

Der dem Projekt zugeordnete Buchungskreis

Show child attributes

project_invites

object[]

Dem Projekt zugewiesene Benutzereinladungen

Show child attributes

Projektkomponenten abrufen Lieferungen auflisten