Schéma

Pour connaitre la liste des champs d’un objet et la liste des sous objets disponibles vous pouvez utiliser la requête suivante :

Exemple :

1. {


2. • "queryUid": "9edbf7bcddfbd0f0db649b6da8680d61",


3. • "offset": 10,


4. • "limit": 10,


5. • "page": 2,


6. • "pages": 3,


7. • "total": 25,


8. • "data": [{


9. • • "id": "1",


10. • • "label": "Lex Luthor",


11. • • "employeeid": "1",


12. • • ...


13. • • "skills":[


14. • • • "id": "1:1",


15. • • • "label": "MySql",


16. • • • "employeeid": "1",


17. • • • "skillid": "1",


18. • • • "level": "2",


19. • • • "skill_label": "MySql",


20. • • },


21. • • {


22. • • • "id": "1:2",


23. • • • "label": "Php",


24. • • • "employeeid": "1",


25. • • • "skillid": "2",


26. • • • "level": "4",


27. • • • "skill_label": "Php",


28. • • • }],


29. • "languages": [


30. • • {


31. • • • "id": "1:en",


32. • • • "label": "English",


33. • • • "employeeid": "1",


34. • • • "code": "en",


35. • • • "level": "4",


36. • • }


37. • • ...


38. • }]


39. }

Liste avec les sous objets uniquement

Si vous souhaitez récupérer la liste des sous objets uniquement vous devez utiliser la requête suivante comme dans l’exemple ci-après :

Exemple :

1. {


2. • "fields": [


3. • {


4. • • "id": "employeeid",


5. • • "label": "System ID",


6. • • "uiComponent": {


7. • • • "id": 7,


8. • • • "label": "Number"


9. • • },


10. • • "length": null,


11. • },


12. • {


13. • • "id": "first_name",


14. • • "label": "First name",


15. • • "uiComponent": {


16. • • • "id": 1,


17. • • • "label": "Input"


18. • • },


19. • • "length": 255,


20. • },


21. • ...


22. • ],


23. • "branches": [


24. • • "user",


25. • • "addresses",


26. • • "experiences",


27. • • "skills",


28. • • "partners",


29. • • "certifications",


30. • • "documents",


31. • • "salaryHistory",


32. • • "languages",


33. • • "publications",


34. • • "salaryBonus",


35. • • "educations",


36. • • "notes",


37. • • "metadata",


38. • • "assets",


39. • • "costHistory"


40. • ],


41. }

Schéma des « sous objets / branches »

Pour obtenir le schéma des sous objets d’un objet principale il suffit d’utiliser le point d’entrée suivant :

Exemple de requête :

1. {


2. • "fields": [


3. • {


4. • • "id": "code",


5. • • "label": "Langue parlée",


6. • • "uiComponent": {


7. • • • "id": 2,


8. • • • "label": "Liste déroulante"


9. • • • "related": {


10. • • • • "id": "112",


11. • • • • "label": "Langue parlée",


12. • • • • "urn": "application/entities/112/values/",


13. • • • }


14. • • },


15. • • "length": null,


16. • },


17. • {


18. • • "id": "Level",


19. • • "label": "Niveau",


20. • • "uiComponent": {


21. • • • "id": 2,


22. • • • "label": "Liste déroulante"


23. • • • "related": {


24. • • • • "id": "113",


25. • • • • "label": "Niveau",


26. • • • • "urn": "application/entities/113/values/",


27. • • • }


28. • • },


29. • • "length": null,


30. • }],


31. • "branches": [


32. • • "endorsements",


33. • • "languages",


34. • ]


35. }

Certains champs reposent sur des composants de type liste déroulante, il s’agit soit de liste statique (non modifiable via le paramétrage) soit de liste dynamique (reposant elle-même sur une entité de Nicoka). Dans le second cas vous verrez apparaitre les informations « related » vous donnant :

• id : l’identifiant unique de l’entité de référence


• label : le libellé dans la langue de requête


• urn : le point d’entrée de l’api qui affiche les paramètres de l’entité. Si l’entité n’a pas un point d’entrée spécifique il sera toujours sous la forme « application/entities/{id_of_the_entity}/values/ » afin d’obtenir la liste des valeurs existantes pour cette entité.

Exemple de requête pour afficher la liste des niveaux de langues :

Exemple de requête :