Cas particulier des champs spécifiques
Informations
Lorsque vous ajoutez des champs à un objet Nicoka, vous pouvez y accéder via la « branch » metadata (au singulier). Pour obtenir la description des champs spécifiques vous devez utiliser le point d’entrée « customFields » :
https://{account_subdomain}.nicoka.com/api/employees/customFields/ GET
Remarque
Vous n'avez pas la possibilité d'enrichir avec des champs spécifiques tous les objets de Nicoka.
Exemple de requête :
curl https://{account_subdomain}.nicoka.com/api/employees/customFields/ GET
-H "Authorization: Bearer
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxIiwiZXhwIjoxNTQ4MTAyNTExfQ.a96HA5xozI_6TE65ybC5RsXdOfSuHd4Wbmhswb-V1nw"
- {
- "fields": [{
- "id": "1",
- "label": "Identifiant RPPSs",
- "fieldid": "1",
- "language": "en",
- "ui_componentid": "1",
- "ui_size": "3",
- "size": null,
- "required": "0",
- "in_search_engine": "1",
- "position": "2",
- "categoryid": "1",
- "params": null,
- "active": "1",
- "loekz": "0",
- "cdate": "2014-09-04 12:00:44",
- "cname": "1",
- "udate": "2017-01-28 20:26:48",
- "uname": "1",
- "versi": "4",
- "ogi nalLanguage": "RPPS ID",
- },
- {
- "id": "2",
- "label": "Imputation Comptable",
- "fieldid": "2",
- ...
- "loekz": "0",
- "cdate": "2014-09-11 15:15:25",
- "cname": "4",
- "udate": "2017-01-28 20:26:48",
- "uname": "1",
- "versi": "3",
- "labelInOriginalLanguage": "Account Info.",
- }]
- }
Afficher les champs spécifiques dans une recherche d’objets
Si vous souhaitez récupérer la valeur des champs spécifiques dans vos requêtes de liste d’objets vous devez ajouter le paramètre « __metadata » dans l’url de la requête :
https://{account_subdomain}.nicoka.com/api/{resource_name_in_plural}/?__metadata=1 GET
Exemple de requête :
curl https://{account_subdomain}.nicoka.com/api/employees/?__metadata=1 GET
-H "Authorization: Bearer
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxIiwiZXhwIjoxNTQ4MTAyNTExfQ.a96HA5xozI_6TE65ybC5RsXdOfSuHd4Wbmhswb-V1nw"
- {
- "queryUid": "9edbf7bcddfbd0f0db649b6da8680d61",
- "offset": 0,
- "limit": 26,
- "page": 1,
- "pages": 1,
- "total": 26,
- "data": [{
- "employeeid": "7",
- "code": "0005",
- ...
- "id": "7",
- "label": "Adam Black",
- "cus_fld_1": "Ok",
- "cus_fld_3": "Bleu",
- "cus_fld_4": "12",
- "cus_fld_5": "1",
- "cus_fld_20": "2016-02-02",
- },
- ...
- ]}
- }
Les champs spécifiques ont la forme suivante :
cus_fld_{fieldid} : {value}