Position API verte - Unités organisationnelles

Modifié le Lun, 24 Nov. à 12:44 H

Obtenir les unités organisationnelles

Obtenir les unités organisationnelles à partir de la plateforme Position Green à l'aide d'un identifiant externe (PrettyId) ou de l'identifiant de l'unité organisationnelle. De plus, le paramètre includeSubunits permet d'obtenir toutes les sous-organisations du PrettyId ou de l'ID fourni.

Propriétés de l'objet Unité organisationnelle

Propriété	Type de données	Description
id	Guide	Identifiant de l'unité organisationnelle
globalId	Guide	Identifiant global de l'unité organisationnelle
annéeId	Guide	Identifiant de l'année attribué à l'unité organisationnelle
prettyId	chaîne	Identifiant unique de l'unité organisationnelle
parentId	Guide	Identifiant parent de l'unité organisationnelle
identifiant_organisation	Guide	Identifiant du locataire auquel appartient l'unité organisationnelle

GET/Unité organisationnelle

Consultez la section « Unité organisationnelle » sur notre page Swagger UI.

Ce point de terminaison API renverra les unités organisationnelles de trois manières spécifiques :

Toutes les unités organisationnelles du locataire - si aucun paramètre de requête n'est fourni ;
Unité organisationnelle spécifique - si Id ou PrettyId est fourni ;
Unité organisationnelle spécifique avec toutes ses sous-unités - si Id ou PrettyId est fourni et que IncludeSubunits est défini sur true ;

Exemple de réponse :

{
    "totalCount": 2,
    "items": [
        {
            "id": "346788a-fd74-fd74-fd74-fd74a1c08e8b",
            "globalId": "1234567-fd74-abcd-fd74-930fa1c18e8b",
            "name": "Nom de l'unité organisationnelle",
            "yearId": "3825cdbb-3795-4f0b-9854-21d9e3a0b50a",
            "prettyId": « Identifiant simplifié de l'organisation »,
            « parentId » : null,
            « organizationId » : « dfc751db-59ca-4ae7-878f-65fe1af0017e »
        },
        {
            « id » : « 2ca630f1-07d5-4ee4-9d29-ec95766732ec »,
            « globalId » : « 8034bedf-1b7a-4e5e-96c7-0379622c6add »,
            « name » : « Nom de la sous-unité de l'organisation »,
            « yearId » : « 3825cdbb-3795-4f0b-9854-21d9e3a0b50a »,
            « prettyId » : « Identifiant simplifié de la sous-unité organisationnelle »,
            « parentId » : « 346788a-fd74-fd74-fd74-fd74a1c08e8b »,
            « organizationId » : « dfc751db-59ca-4ae7-878f-65fe1af0017e »
        }        
    ]
}

Créer une nouvelle unité organisationnelle

Créer une nouvelle unité organisationnelle dans la plateforme Position Green

Paramètre	Obligatoire	Type	Description
nom	Oui	chaîne	Nom de l'unité organisationnelle
parentId	Non	Guide	Identifiant du parent (facultatif)
prettyId	Oui	chaîne
complexData (tableau de)	Non	JSONObject[]	Données complexes de l'unité organisationnelle (par exemple { « name » : « culture », « data » : « en », « type » : « String » })
nom	Oui	chaîne	Nom de l'élément du complexe de données
données	Oui	objet	Données de l'élément

type	Oui	énumération	Valeurs possibles : [Chaîne, Nombre, Date, Booléen]
superviseur	Non	JSONObject	Responsable de l'unité organisationnelle
prénom	Oui	chaîne	Prénom du superviseur
nom	Oui	chaîne	Nom de famille du superviseur
courriel	Oui	chaîne	Courriel du superviseur

POST/Unité organisationnelle

Consultez la section « Unité organisationnelle » sur notre page Swagger UI.

Ce point de terminaison API créera une nouvelle unité organisationnelle dans l'année active et renverra un résumé de l'entité créée.

Exemple de réponse en cas de réussite :

{
    "id": "9620bd7d-8eb3-49a9-9ea2-19463d5aadd7",
    "globalId": "9620bd7d-8eb3-49a9-9ea2-19463d5aadd7",
    "name": « Nouvelle organisation »,
    « 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"
    }
}

Mettre à jour l'unité organisationnelle

Mettre à jour l'unité organisationnelle dans la plateforme Position Green.

Paramètre	Obligatoire	Type	Description
nom	Oui	chaîne	Nom de l'unité organisationnelle
parentId	Non	Guide	Identifiant du parent (facultatif)
prettyId	Oui	chaîne
complexData (tableau de)	Non	JsonObject[]	Données complexes de l'unité organisationnelle (par exemple { « name » : « culture », « data » : « en », « type » : « String » })
nom	Oui	chaîne	Nom de l'élément du complexe de données
données	Oui	objet	Données de l'élément

type	Oui	énumération	Valeurs possibles : [ Chaîne, Nombre, Date, Booléen ]
superviseur	Non	JSONObject	Responsable de l'unité organisationnelle
prénom	Oui	chaîne	Prénom du superviseur
nom	Oui	chaîne	Nom de famille du superviseur
courriel	Oui	chaîne	Courriel du superviseur

PUT/Unité organisationnelle/{id}

Consultez la section « Unité organisationnelle » sur notre page Swagger UI.

Ce point de terminaison API mettra à jour l'unité organisationnelle et renverra un résumé de l'entité mise à jour.

Exemple de réponse en cas de réussite :

{
    "id": "9620bd7d-8eb3-49a9-9ea2-19463d5aadd7",
    "globalId": "9620bd7d-8eb3-49a9-9ea2-19463d5aadd7",
    « name » : « Organisation mise à jour »,
    « 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"
    }
}

Supprimer l'unité organisationnelle

Supprimer une unité organisationnelle

DELETE/Unité organisationnelle/{orgUnitId}

Consultez la section « Unité organisationnelle » sur notre page Swagger UI.