Position Green API - Organisatoriska enheter

Ändrad den Ons, 18 juni vid 11:49 F.M.

Hämta organisationsenheter

Hämta organisationsenheter från Position Green Plattform med ett externt id (PrettyID) eller ID för organisationsenheten. Dessutom gör parametern includeSubunits det möjligt att hämta alla underorganisationer för angivet PrettyID eller ID.

Egenskaper för objektet Organisationsenhet

Egendom	Typ av data	Beskrivning
id	Vägledning	Id för organisationsenheten
globalId	Vägledning	Globalt id för organisationsenheten
årId	Vägledning	Id för år som tilldelats organisationsenheten
PrettyID	sträng	Pretty Id för organisationsenheten
förälderId	Vägledning	Organisationsenhetens föräldrar-ID
organisationId	Vägledning	Id för den hyresgäst som organisationsenheten tillhör

GET/Organisationsenhet

Kontrollera avsnittet Organisatorisk enhet på vår swagger UI-sida.

Denna API-slutpunkt kommer att returnera organisationsenheter på 3 specifika sätt:

Alla organisationsenheter för hyresgästen - om det inte finns några parametrar för begäran;
Specifik organisationsenhet - om Id eller PrettyID anges;
Specifik organisationsenhet med alla underenheter - om Id eller PrettyID anges och IncludeSubunits är satt till true;

Exempel på svar:

{
    "totalantal": 2,
    "objekt": [
        {
            "id": "346788a-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-fd74a1c08e8b",
            "organizationId":"dfc751db-59ca-4ae7-878f-65fe1af0017e"
        }        
    ]
}

Skapa en ny organisationsenhet

Skapa en ny organisationsenhet i Position Green Plattform

Parameter	Obligatorisk	Ämne	Beskrivning
namn	Ja	sträng	Organisationens namn Enhet
förälderId	Nej	Vägledning	Förälder-ID (valfritt)
PrettyID	Ja	sträng
complexData (array av)	Nej	JSONObject[]	Komplexa data för organisationsenheten (t.ex. {"name": "kultur","data": "en","type": "String" })
namn	Ja	sträng	Namn på datakomplexelement
data	Ja	objekt	Data för elementet

typ	Ja	enum	Möjliga värden: [ String, Number, Date, Bool].
Arbetsledare	Nej	JSONObjekt	Arbetsledare för organisationsenheten
Förnamn	Ja	sträng	Arbetsledarens förnamn
Efternamn	Ja	sträng	Arbetsledarens efternamn
e-post	Ja	sträng	E-postadress till handledaren

POST/Organisationsenhet

Kontrollera avsnittet Organisatorisk enhet på vår swagger UI-sida.

Denna API-slutpunkt skapar en ny organisationsenhet i det aktiva året och returnerar en sammanfattning av den skapade enheten.

Exempel på svar i händelse av framgång:

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

Uppdatera organisationsenhet

Uppdatera organisationsenhet i position Green plattform.

Parameter	Obligatorisk	Ämne	Beskrivning
namn	Ja	sträng	Organisationens namn Enhet
förälderId	Nej	Vägledning	Förälder-ID (valfritt)
PrettyID	Ja	sträng
complexData (array av)	Nej	JsonObject[]	Komplexa data för organisationsenheten (t.ex. {"name": "kultur","data": "en","type": "String" })
namn	Ja	sträng	Namn på datakomplexelement
data	Ja	objekt	Data för elementet

typ	Ja	enum	Möjliga värden: [ Sträng, Nummer, Datum, Bool ]
Arbetsledare	Nej	JSONObjekt	Arbetsledare för organisationsenheten
Förnamn	Ja	sträng	Arbetsledarens förnamn
Efternamn	Ja	sträng	Arbetsledarens efternamn
e-post	Ja	sträng	E-postadress till handledaren

PUT/OrganizationUnit/{id}

Kontrollera avsnittet Organisatorisk enhet på vår swagger UI-sida.

Denna API-slutpunkt kommer att uppdatera organisationsenheten och returnera en sammanfattning av den uppdaterade enheten.

Exempel på svar i händelse av framgång:

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

Ta bort organisationsenhet

Ta bort en organisationsenhet

DELETE/OrganizationUnit/{orgUnitId}

Kontrollera avsnittet Organisatorisk enhet på vår swagger UI-sida.