Position Green API - Organisationseinheiten

Geändert am Mo, 14 Jul um 6:18 NACHMITTAGS

Organisationseinheiten abrufen

Organisationseinheiten können Sie von der Position-Green-Plattform mittels einer externen ID (PrettyID) oder der ID der Organisationseinheit abrufen. Mit dem Parameter "Untereinheiten einbeziehen" können Sie zudem alle Untereinheiten der angegebenen PrettyID oder ID abrufen.

Eigenschaften des Organisationseinheiten-Objekts

Eigenschaft	Datenart	Beschreibung
id	Guid	ID der Organisationseinheit
globalId	Guid	Globale ID der Organisationseinheit
yearId	Guid	ID des Jahres, das der Organisationseinheit zugeordnet ist
prettyId	String	PrettyID der Organisationseinheit
parentId	Guid	ParentID der Organisationseinheit
organisationId	Guid	ID des Tenants, zu dem die Organisationseinheit gehört

GET/OrganizationUnit

Sehen Sie sich den Abschnitt Organisationseinheit auf unserer Swagger-UI-Seite an.

Dieser API-Endpunkt gibt Organisationseinheiten auf 3 spezifische Arten aus:

Alle Organisationseinheiten des Tenants - wenn keine Anforderungsparameter angegeben sind;
Konkrete Organisationseinheit - wenn ID oder PrettyID angegeben wird;
Konkrete Organisationseinheit mit allen Untereinheiten - wenn ID oder PrettyID angegeben wird und "Untereinheiten einbeziehen" auf "wahr" gesetzt ist.

Beispiel für eine Antwort:

{
    "totalCount": 2,
    "items": [
        {
            "id": "346788a-fd74-fd74-fd74-fd74a1c08e8b",
            "globalId": "1234567-fd74-abcd-fd74-930fa1c18e8b",
            "name": "Organization Unit Name",
            "yearId": "3825cdbb-3795-4f0b-9854-21d9e3a0b50a",
            "prettyId": "Org Pretty Id",
            "parentId": null,
            "organizationId": "dfc751db-59ca-4ae7-878f-65fe1af0017e"
        },
        {
            "id": "2ca630f1-07d5-4ee4-9d29-ec95766732ec",
            "globalId": "8034bedf-1b7a-4e5e-96c7-0379622c6add",
            "name": "Org sub-unit Name",
            "yearId": "3825cdbb-3795-4f0b-9854-21d9e3a0b50a",
            "prettyId": "Org sub-unit Pretty Id",
            "parentId": "346788a-fd74-fd74-fd74-fd74a1c08e8b",
            "organizationId":"dfc751db-59ca-4ae7-878f-65fe1af0017e"
        }        
    ]
}

Eine neue Organisationseinheit erstellen

Eine neue Organisationseinheit auf der Position-Green-Plattform erstellen

Parameter	Erforderlich	Art	Beschreibung
name	Ja	String	Bezeichnung der Organisationseinheit
parentId	Nein	Guid	ID des Parents (optional)
prettyId	Ja	String
complexData (array of)	Nein	JSONObject[]	Komplexe Daten der Organisationseinheit (z. B. { "name": "culture", "data": "en", "type": "String" })
name	Ja	String	Bezeichnung des Datenkomplex-Elements
data	Ja	Objekt	Daten des Elements

type	Ja	enum	Mögliche Werte: [ String, Zahl, Datum, Bool]
supervisor	Nein	JSONObject	Betreuer der Organisationseinheit
firstName	Ja	String	Vorname des Betreuers
lastName	Ja	String	Nachname des Betreuers
email	Ja	String	E-Mail-Adresse des Betreuers

POST/OrganizationUnit

Sehen Sie sich den Abschnitt Organisationseinheit auf unserer Swagger-UI-Seite an.

Dieser API-Endpunkt erstellt eine neue Organisationseinheit im aktiven Jahr und gibt eine Zusammenfassung der erstellten Einheit aus.

Beispiel einer Antwort bei richtiger Eingabe:

{
    "id": "9620bd7d-8eb3-49a9-9ea2-19463d5aadd7",
    "globalId": "9620bd7d-8eb3-49a9-9ea2-19463d5aadd7",
    "name": "New organization",
    "yearId": "d338b2e8-eecc-476a-ba56-1853494a7ec9",
    "prettyId": "NewOrg 1",
    "parentId": "346788a-fd74-fd74-fd74-fd74a1c08e8b",
    "organizationId": "dfc751db-59ca-4ae7-878f-65fe1af0017e",
    "complexData": [
        {
            "name": "culture",
            "data": "en",
            "type": "String"
        }
    ],
    "supervisor": {
        "id": "6320ea4c-f274-4d0d-a249-3d23c15d0468",
        "firstName": "FirstName",
        "lastName": "lastName",
        "email": "lastName@example.pl"
    }
}

Eine Organisationseinheit aktualisieren

Eine Organisationseinheit auf der Position-Green-Plattform aktualisieren.

Parameter	Erforderlich	Art	Beschreibung
name	Ja	String	Bezeichnung der Organisationseinheit
parentId	Nein	Guid	ID des Parents (optional)
prettyId	Ja	String
complexData (array of)	Nein	JsonObject[]	Komplexe Daten der Organisationseinheit (z. B. { "name": "culture", "data": "en", "type": "String" })
name	Ja	String	Bezeichnung des Datenkomplex-Elements
data	Ja	Objekt	Daten des Elements

type	Ja	enum	Mögliche Werte: [ String, Zahl, Datum, Bool ]
supervisor	Nein	JSONObject	Betreuer der Organisationseinheit
firstName	Ja	String	Vorname des Betreuers
lastName	Ja	String	Nachname des Betreuers
email	Ja	String	E-Mail-Adresse des Betreuers

PUT/OrganizationUnit/{id}

Sehen Sie sich den Abschnitt Organisationseinheit auf unserer Swagger-UI-Seite an.

Dieser API-Endpunkt aktualisiert die Organisationseinheit und gibt eine Zusammenfassung der aktualisierten Einheit aus.

Beispiel einer Antwort bei richtiger Eingabe:

{
    "id": "9620bd7d-8eb3-49a9-9ea2-19463d5aadd7",
    "globalId": "9620bd7d-8eb3-49a9-9ea2-19463d5aadd7",
    "name": "Updated organization",
    "yearId": "d338b2e8-eecc-476a-ba56-1853494a7ec9",
    "prettyId": "UpdOrgPretty 1",
    "parentId": "346788a-fd74-fd74-fd74-fd74a1c08e8b",
    "organizationId": "dfc751db-59ca-4ae7-878f-65fe1af0017e",
    "complexData": [
        {
            "name": "culture",
            "data": "en",
            "type": "String"
        }
    ],
    "supervisor": {
        "id": "6320ea4c-f274-4d0d-a249-3d23c15d0468",
        "firstName": "FirstName",
        "lastName": "lastName",
        "email": "lastName@example.pl"
    }
}

Eine Organisationseinheit löschen

DELETE/OrganizationUnit/{orgUnitId}

Sehen Sie sich den Abschnitt Organisationseinheit auf unserer Swagger UI-Seite an.