Skip to main content
POST
/
project-regions
curl --request POST \
  --url https://api.comstruct.com/v1/project-regions \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
[
  {
    "title": "North Region",
    "number": "REG-NORTH"
  }
]
'
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "title": "North Region",
    "number": "REG-NORTH",
    "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.

Erforderliche Berechtigungen:

  • deliveries:read - Lieferdaten lesen
  • deliveries:write - Lieferungen erstellen und ändern
  • invoices:read - Rechnungsdaten lesen
  • invoices:write - Rechnungen erstellen und ändern
  • projects:read - Projektdaten lesen
  • projects:write - Projekte erstellen und ändern
  • project_regions:read - Projektregionsdaten lesen
  • project_regions:write - Projektregionen erstellen und ändern
  • accounts:read - Kontodaten lesen
  • accounts:write - Konten erstellen und ändern
  • payment_terms:read - Zahlungsbedingungsdaten lesen
  • payment_terms:write - Zahlungsbedingungen erstellen und ändern
  • tax_codes:read - Steuercodedaten lesen
  • tax_codes:write - Steuercodes erstellen und ändern
  • users:read - Benutzerdaten lesen (erforderlich für Projekt-Benutzerverwaltung)
  • roles:read - Rollendaten lesen (erforderlich für Projekt-Rollenzuweisung)
  • tenant_settings:read - Mandanteneinstellungen lesen (erforderlich für Projekterstellung)
  • suppliers:write - Lieferanten erstellen und ändern
  • purchase_orders:write - Bestellungen erstellen

Body

application/json
​
title
string
required

Der Titel der Projektregion

Example:

"North Region"

​
number
string
required

Die Nummer/der Code der Projektregion

Example:

"REG-NORTH"

Response

Projektregionen erfolgreich erstellt oder aktualisiert

​
id
string<uuid>

Die eindeutige Kennung der Projektregion

​
title
string

Der Titel der Projektregion

Example:

"North Region"

​
number
string

Die Nummer/der Code der Projektregion

Example:

"REG-NORTH"

​
tenant_id
string<uuid>

Die Mandanten-ID