Arbeitsbereich

Hier finden Sie Informationen zu allen API-Befehlen und -Abfragen im Zusammenhang mit Arbeitsbereichen.

Abfragen

---

get_workspace

Ruft die Details eines Arbeitsbereichs ab.

Parameter

• id (erforderlich): Die ID des Arbeitsbereichs.

Beispiel

curl -X POST 'https://app.polyteia.com/api' \
    -header "Content-Type: application/json" \
    -header "Authorization: Bearer <your_access_token>" \
    --data '{
        "query": "get_workspace",
        "params": {
            "id": "ws_cv33u4n0i6q45p93i930"
        }
    }'

Arbeitsbereich-Antwort

• id: Die ID des Arbeitsbereichs.

• organization_id: Die ID der Organisation, zu der der Arbeitsbereich gehört.

• created_at: Datum und Uhrzeit der Erstellung des Arbeitsbereichs.

• updated_at: Datum und Uhrzeit der letzten Aktualisierung des Arbeitsbereichs.

• name: Der Name des Arbeitsbereichs.

• description: Die Beschreibung des Arbeitsbereichs.

• attributes: Optionale Schlüssel-Wert-Paare, die dem Arbeitsbereich zugeordnet sind.

Beispielantwort

{
    "data": {
        "id": "ws_cv33u4n0i6q45p93i930",
        "organization_id": "org_cv33u4n0i6q45p93i930",
        "created_at": "2025-03-24T15:12:49.186202Z",
        "updated_at": "2025-03-24T20:01:59.408382Z",
        "name": "Finanzen",
        "description": "Arbeitsbereich der Finanzabteilung",
        "attributes": {
            "key": "value"
        }
    }
}

---

list_workspaces

Seitenweise Auflistung aller Arbeitsbereiche, auf die der Benutzer Zugriff hat.

Parameter

• page (erforderlich): Die zurückzugebende Seitennummer. minimum: 1

• size (erforderlich): Die Anzahl der Elemente pro Seite. minimum: 1, maximum: 100

Beispiel

curl -X POST 'https://app.polyteia.com/api' \
    -header "Content-Type: application/json" \
    -header "Authorization: Bearer <your_access_token>" \
    --data '{
        "query": "list_workspaces",
        "params": {
            "page": 1,
            "size": 10
        }
    }'

Antwort

• total: Die Gesamtanzahl der Arbeitsbereiche, auf die der Benutzer Zugriff hat.

• page: Die aktuelle Seitennummer.

• size: Die angeforderte Anzahl von Elementen pro Seite.

• items: Ein Array von Arbeitsbereichen. Weitere Details finden Sie unter Arbeitsbereich-Antwort.

Beispielantwort

{
    "data": {
        "total": 1,
        "page": 1,
        "size": 100,
        "items": [
            {
                "id": "ws_cv33u4n0i6q45p93i930",
                "organization_id": "org_cv33u4n0i6q45p93i930",
                "created_at": "2025-03-24T15:12:49.186202Z",
                "updated_at": "2025-03-24T20:01:59.408382Z",
                "name": "Finanzen",
                "description": "Arbeitsbereich der Finanzabteilung"
            }
        ]
    }
}

Befehle

---

create_workspace

Verwenden Sie diesen Befehl, um einen neuen Arbeitsbereich zu erstellen.

Parameter

• organization_id (erforderlich): Die ID der Organisation, in der der Arbeitsbereich erstellt werden soll.

• name (erforderlich): Name des Arbeitsbereichs. minimum: 1 maximum: 50 nur Unicode-Zeichen

• description (optional): Beschreibung des Arbeitsbereichs. maximum: 255 nur Unicode-Zeichen

• attributes (optional): Optionale Schlüssel-Wert-Paare, die dem Arbeitsbereich zugeordnet werden sollen.

Beispiel

curl -X POST 'https://app.polyteia.com/api' \
    -header "Content-Type: application/json" \
    -header "Authorization: Bearer <your_access_token>" \
    --data '{
        "query": "create_workspace",
        "params": {
            "organization_id": "org_cv33u4n0i6q45p93i930",
            "name": "Finanzen",
            "description": "Arbeitsbereich der Finanzabteilung",
            "attributes": {
                "key1": "value1",
                "key2": 100,
                "key3": {
                    "nested": true
                }
            }
        }
    }'

Antwort

Die Antwort ist die Arbeitsbereich-Antwort des erstellten Arbeitsbereichs.

Beispielantwort

{
    "data": {
        "id": "ws_cv33u4n0i6q45p93i930",
        "organization_id": "org_cv33u4n0i6q45p93i930",
        "created_at": "2025-03-24T15:12:49.186202Z",
        "updated_at": "2025-03-24T20:01:59.408382Z",
        "name": "Finanzen",
        "description": "Arbeitsbereich der Finanzabteilung",
        "attributes": {
            "key": "value"
        }
    }
}

Speichern Sie die id für spätere Referenzen oder Aktualisierungen des Arbeitsbereichs.

---

update_workspace

Verwenden Sie diesen Befehl, um einen Arbeitsbereich zu aktualisieren.

Parameter

• id (erforderlich): Die ID des zu aktualisierenden Arbeitsbereichs.

• name (erforderlich): Der Name des Arbeitsbereichs.

• description (optional): Die Beschreibung des Arbeitsbereichs.

• attributes (optional): Ein JSON-Objekt mit Schlüssel-Wert-Paaren, die dem Arbeitsbereich hinzugefügt werden sollen.

Beispiel

curl -X POST 'https://app.polyteia.com/api' \
    -header "Content-Type: application/json" \
    -header "Authorization: Bearer <your_access_token>" \
    --data '{
        "query": "update_workspace",
        "params": {
            "id": "ws_cv33u4n0i6q45p93i930",
            "name": "Mein Arbeitsbereich",
            "description": "Beschreibung meines Arbeitsbereichs",
            "attributes": {
                "key": "new_value"
            }
        }
    }'

Antwort

Die Antwort ist die Arbeitsbereich-Antwort des aktualisierten Arbeitsbereichs.

Beispielantwort

{
    "data": {
        "id": "ws_cv33u4n0i6q45p93i930",
        "organization_id": "org_cv33u4n0i6q45p93i930",
        "created_at": "2025-03-24T15:12:49.186202Z",
        "updated_at": "2025-03-24T20:01:59.408382Z",
        "name": "Mein Arbeitsbereich",
        "description": "Beschreibung meines Arbeitsbereichs",
        "attributes": {
            "key": "new_value"
        }
    }
}

---

delete_workspace

Verwenden Sie diesen Befehl, um einen Arbeitsbereich zu löschen.

Diese Aktion ist nicht rückgängig zu machen. Verwenden Sie diesen Befehl mit Vorsicht.

Parameter

• id (erforderlich): Die ID des zu löschenden Arbeitsbereichs.

Beispiel

curl -X POST 'https://app.polyteia.com/api' \
    -header "Content-Type: application/json" \
    -header "Authorization: Bearer <your_access_token>" \
    --data '{
        "query": "delete_workspace",
        "params": {
            "id": "ws_cv33u4n0i6q45p93i930"
        }
    }'

Antwort

Die Antwort ist die Arbeitsbereich-Antwort des gelöschten Arbeitsbereichs.

{
    "data": {
        "id": "ws_cv33u4n0i6q45p93i930"
    }
}

• id: Die ID des gelöschten Arbeitsbereichs.