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"
}
]
Stammdaten
Projektregionen erstellen/aktualisieren
Erforderliche Berechtigungen: project_regions:write
Erstellt oder aktualisiert eine oder mehrere Projektregionen für den aktuellen Mandanten.
Verwendet das number-Feld zum Abgleich bestehender Projektregionen für Aktualisierungen.
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"
}
]
Übersicht
Dieser Endpunkt erstellt neue Projektregionen oder aktualisiert bestehende. Projektregionen helfen dabei, Projekte nach geografischen oder organisatorischen Grenzen zu organisieren.Feld Region Description
Das Felddescription ist ein optionales Freitextfeld, das zusätzlichen Kontext über die Projektregion bietet. Es ist nützlich für:
- Dokumentation der geografischen Abdeckung (z. B. ‘Nordregion mit Lagern A und B’)
- Organisatorische Hinweise (z. B. ‘Regionalbüro Hamburg, Team Nord’)
- Besondere Bearbeitungshinweise für die Region
Das Feld
description ist optional und kann bei der Erstellung hinzugefügt oder später über den PATCH-Endpunkt aktualisiert werden.Beispiel: Region mit Description erstellen
{
"title": "Nord",
"number": "REG-001",
"description": "Nordregion mit Lagern A und B"
}
Beispiel: Region ohne Description erstellen
{
"title": "Süd",
"number": "REG-002"
}
Autorisierungen
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