Skip to content

Formation

Généralités

Les entités et endpoints décrits ci-dessous ne sont pas une liste exhaustive. Ils ne représentent que les plus couramment utilisés.

Veuillez vous référer au chapitre USAGE pour en savoir plus.

Remarque

Les paramètres énumérés pour les requêtes "POST" sont uniquement des exemples de paramètres obligatoires. Ils varient selon le sous-domaine utilisé.

L'ensemble des paramètres sont disponibles dans la section "Attributes" de chaque entité

Chemin

Pour accéder à votre API depuis un compte en production vous devez utiliser le chemin suivant : 

https://<account_subdomain>.nicoka.com/api/
Si vous souhaitez tester l’API depuis un compte d’essai vous devez utiliser le chemin suivant : 
https://trial.nicoka.com/<account_subdomain>/api/

Note

<account_subdomain> désigne le nom de votre sous-domaine Nicoka

Connexion à l'API

Voir le chapitre Connexion à l'API

Valeurs des listes déroulantes

Dans cette page, vous trouverez les principales entités et endpoints nécesssaires.
La valeur de certains attributs sont disponibles dans Nicoka sous forme de liste. Cette liste est :

  • soit disponible depuis le endpoint référencé directement sous l'attribut
  • soit reliée à une entité décrite dans cette documentation API
Exemple 1 : Endpoint référencé directement sous l'attribut

source int (Liste déroulante : Provenance)
Provenance de la candidature
Endpoint de récupération des valeurs: /application/entities/462/values/

La liste des valeurs possibles pour source est disponible à cet url:

  • https://<account_subdomain>.nicoka.com/api/application/entities/462/values/ pour un compte en production
  • https://trial.nicoka.com/<account_subdomain>/api/application/entities/462/values/ pour compte d'essai
Exemple 2 : Endpoint relié à une entité décrite dans cette documentation

candidateid int (Liste déroulante : Candidat)
Candidat

cliquer sur le lien Liste déroulante : Candidat à côté de l'attribut. Vous serez redirigé vers l'entité correspondante,ici l'entité Candidat.
Vous pourrez alors obtenir la Liste des candidats avec le endpoint correspondant GET /candidates.

Formation

Overview

Attributes

trainingid int
ID Système

compid int (Liste déroulante : Société)
Société

label string
Libellé

parentid int (Liste déroulante : Formation)
Formation parent

modelid int (Liste déroulante : Formation (Catalogue))
Formation (Catalogue)
Endpoint de récupération des valeurs: /application/entities/153/values/

categoryid int (Liste déroulante : Catégorie)
Catégorie
Endpoint de récupération des valeurs: /application/entities/154/values/

external_reference string
Réf. Externe

type int
Type

domainid int (Liste déroulante : Domaine)
Domaine
Endpoint de récupération des valeurs: /application/entities/1450/values/

start_date datetime
Début le

status int (Liste déroulante : Statut)
Statut
Endpoint de récupération des valeurs: /application/entities/686/values/

start_time string
Heure de début

duration float
Durée

duration_unit int
Unité de durée

end_date datetime
Fin le

expires_on date
Expire le

projectid int (Liste déroulante : Projet)
Projet

supplierid int (Liste déroulante : Fournisseur)
Fournisseur

renewed boolean
Renouvelé(e)

contactid int (Liste déroulante : Contact)
Contact

renewed_on date
Renouvelé(e) le

author_name string
Auteur

description string (TEXT)
Description

renewed_trainingid int (Liste déroulante : Formation)
Formation renouvelée

in_timesheets boolean
Feuille de temps ?

cdate datetime
Créé le

employeeid int (Liste déroulante : Collaborateur)
Auteur Interne

cname int (Liste déroulante : Utilisateur)
Créé par

estimated_cost double
Coût (Estimation)

nb_of_participants int
Nb. de participants

nb_of_present_attendees int
Nb. de participants présents

udate datetime
MàJ le

real_cost double
Coût (réel)

uname int (Liste déroulante : Utilisateur)
MàJ par

currency string
Devise

travel_cost double
Coût Transport

assumed_by_third_party_id int (Liste déroulante : Tier)
Prise en charge par
Endpoint de récupération des valeurs: /application/entities/685/values/

accommodation_cost double
Coût Hébergement

amount_assumed_by_third_party double
Montant prise en charge

other_cost double
Autres Coûts

salary_cost double
Coût salarial

amount_assumed_by_employee double
Montant prise en charge par le collaborateur

total_training_cost double
Coût Total (Hors Salaire)

locationid int (Liste déroulante : Agence)
Agence

street string
Adresse

city string
Ville

zipcode string
Code Postal

amount_to_be_assumed double
Reste à charge

country int (Liste déroulante : Pays)
Pays
Endpoint de récupération des valeurs: /application/entities/13/values/

comments string (TEXT)
Commentaires

inline_attendees string
Participants

ENDPOINTS

Liste des formations

REQUEST

GET /trainings

RESPONSE

200 OK

{
    "queryUid": "00c6f7d3ca01a8d681d9dc4ccd1c1bc6",
    "offset": 0,
    "limit": 3,
    "page": 1,
    "pages": 1,
    "total": 3,
    "data": [  
        {
            "id": 2,
            "trainingid": 2,
            "parentid": null,
            "modelid": null,
            "language": "fr",
            "label": "Management TTSO",
            "external_reference": null,
            "status": 3,
            "status_udate": null,
            "type": 2,
            "categoryid": null,
            "domainid": null,
            "ref_entityid": null,
            "ref_objectid": null,
            "projectid": null,
            "requestid": null,
            "start_date": "2022-03-12 08:00:00",
            "start_time": "08:00",
            "duration": 55,
            "duration_unit": 2,
            "end_date": "2022-03-14 15:00:00",
            "expires_on": null,
            "in_timesheets": 0,
            "compid": 1,
            "training_company": "FORMATION FORMATION",
            "supplierid": 119,
            "contactid": null,
            "employeeid": null,
            "eventid": null,
            "author_name": null,
            "nb_of_participants": 1,
            "nb_of_present_attendees": 1,
            "inline_attendees": "[{\"id\":\"101__49\",\"role\":2,\"name\":\"Jean Durand\",\"presence\":1}]",
            "estimated_cost": null,
            "travel_cost": null,
            "accommodation_cost": null,
            "other_cost": null,
            "salary_cost": null,
            "total_training_cost": 0,
            "real_cost": null,
            "currency": null,
            "comments": null,
            "assumed_by_third_party_id": null,
            "amount_assumed_by_third_party": 0,
            "amount_assumed_by_employee": null,
            "amount_to_be_assumed": 0,
            "renewed": 0,
            "renewed_trainingid": null,
            "renewed_on": null,
            "indexing_status": null,
            "description": "",
            "address_related_type": null,
            "locationid": null,
            "street_number": null,
            "street": null,
            "street_only": null,
            "zipcode": null,
            "city": null,
            "address_state": null,
            "county": null,
            "country": null,
            "areaid": null,
            "area_level": null,
            "area_lvl1": null,
            "area_lvl2": null,
            "area_lvl3": null,
            "area_lvl4": null,
            "area_lvl5": null,
            "area_lvl6": null,
            "area_lvl7": null,
            "lat": null,
            "lng": null,
            "loekz": 0,
            "cdate": "2025-09-12 17:05:31",
            "cname": 46,
            "udate": "2025-09-12 17:05:31",
            "uname": 46,
            "versi": 1
        },
        {
            "id": 1,
            "trainingid": 1,
            "parentid": null,
            "modelid": null,
            "language": "en",
            "label": "Risque incendie",
            "external_reference": null,
            "status": 3,
            "status_udate": null,
            "type": 1,
            "categoryid": null,
            "domainid": null,
            "ref_entityid": null,
            "ref_objectid": null,
            "projectid": null,
            "requestid": null,
            "start_date": "2014-09-01 00:00:00",
            "start_time": "9:20",
            "duration": 5,
            "duration_unit": 2,
            "end_date": "2014-09-01 14:20:00",
            "expires_on": null,
            "in_timesheets": 0,
            "compid": 1,
            "training_company": null,
            "supplierid": null,
            "contactid": null,
            "employeeid": 1,
            "eventid": null,
            "author_name": "Xavier V",
            "nb_of_participants": 0,
            "nb_of_present_attendees": 0,
            "inline_attendees": null,
            "estimated_cost": null,
            "travel_cost": null,
            "accommodation_cost": null,
            "other_cost": null,
            "salary_cost": null,
            "total_training_cost": null,
            "real_cost": null,
            "currency": null,
            "comments": null,
            "assumed_by_third_party_id": null,
            "amount_assumed_by_third_party": null,
            "amount_assumed_by_employee": null,
            "amount_to_be_assumed": null,
            "renewed": 0,
            "renewed_trainingid": null,
            "renewed_on": null,
            "indexing_status": 0,
            "description": "",
            "address_related_type": null,
            "locationid": null,
            "street_number": null,
            "street": null,
            "street_only": null,
            "zipcode": null,
            "city": null,
            "address_state": null,
            "county": null,
            "country": null,
            "areaid": null,
            "area_level": null,
            "area_lvl1": null,
            "area_lvl2": null,
            "area_lvl3": null,
            "area_lvl4": null,
            "area_lvl5": null,
            "area_lvl6": null,
            "area_lvl7": null,
            "lat": null,
            "lng": null,
            "loekz": 0,
            "cdate": "2014-09-13 21:26:25",
            "cname": 1,
            "udate": "2014-10-21 17:08:54",
            "uname": 6,
            "versi": 2
        }
    ]
}

Créer une nouvelle formation

REQUEST

POST /trainings

RESPONSE

200 OK

Récupérer une formation

Path params

Trainingid (int)
Identifiant d'une formation

REQUEST

GET /trainings/{trainingid}

RESPONSE

200 OK

Demande de formation

Overview

Attributes

requestid int
ID Système

modelid int (Liste déroulante : Formation (Catalogue))
Formation (Catalogue)
Endpoint de récupération des valeurs: /application/entities/153/values/

target_entityid int (Liste déroulante : Entité)
Cible (Entité)
Endpoint de récupération des valeurs: /application/entities/2/values/

type int
Type

target_objectid int
Cible (Id)

label string
Libellé

priorityid int (Liste déroulante : Priorité)
Priorité
Endpoint de récupération des valeurs: /application/entities/683/values/

target_employeeid int (Liste déroulante : Collaborateur)
Collaborateur

compid int (Liste déroulante : Société)
Société

campaignid int (Liste déroulante : Campagne)
Campagne
Endpoint de récupération des valeurs: /application/entities/4010/values/

evaluationid int (Liste déroulante : Entretien)
Entretien
Endpoint de récupération des valeurs: /application/entities/4000/values/

planid int (Liste déroulante : Plan de formation)
Plan de formation

trainingid int (Liste déroulante : Formation)
Formation

requester_name string
Demandeur

status int
Statut (Workflow)

estimated_cost double
Coût (Estimation)

workflow_date datetime
Date (Workflow)

comments longtext
Commentaires

cdate datetime
Créé le

cname int (Liste déroulante : Utilisateur)
Créé par

uname int (Liste déroulante : Utilisateur)
MàJ par

udate datetime
MàJ le

ENDPOINTS

Liste des demandes de formation

REQUEST

GET /trainingRequests

RESPONSE

200 OK

Créer une nouvelle demande de formation

REQUEST

POST /trainingRequests

RESPONSE

200 OK

Récupérer une demande de formation

Path params

Requestid (int)
Identifiant d'une demande de formation

REQUEST

GET /trainingRequests/{requestid}

RESPONSE

200 OK

Plan de formation

Overview

Attributes

planid int
ID Système

label string
Libellé

date date
Date

estimated_cost double
Coût (Estimation)

plan_nb_of_hours float
Nb. Heures

status int
Status

comments string (TEXT)
Commentaires

ENDPOINTS

Liste des plans de formation

REQUEST

GET /trainingPlans

RESPONSE

200 OK

Créer un nouveau plan de formation

REQUEST

POST /trainingPlans

RESPONSE

200 OK

Récupérer un plan de formation

Path params

Planid (int)
Identifiant d'un plan de formation

REQUEST

GET /trainingPlans/{planid}

RESPONSE

200 OK