Skip to content

PROJET

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.

Projet

Overview

Attributes

projectid int
ID Système

parent_projectid int (Liste déroulante : Projet)
Projet parent

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

type int (Liste déroulante : Type)
Type
Endpoint de récupération des valeurs: /application/entities/801/values/

phaseid int (Liste déroulante : Phase)
Phase
Endpoint de récupération des valeurs: /application/entities/839/values/

reference string
Code

label string
Libellé

phase_udate datetime
Phase (MàJ le)

external_reference string
Réf. Externe

ticket_prefix string
Préfix de numérotation des tickets

customerid int (Liste déroulante : Compte)
Compte

quotationid int (Liste déroulante : Devis)
Devis

orderid int (Liste déroulante : Commande)
Commande

opid int (Liste déroulante : Opportunité)
Opportunité

invoiceid int (Liste déroulante : Facture)
Facture

start_date date
Début le

end_date date
Fin le

color string
Couleur

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

picture string
Logo

currency int (Liste déroulante : Devise)
Devise
Endpoint de récupération des valeurs: /application/entities/9/values/

main_contactid int (Liste déroulante : Contact)
Contact Principal

ts_enable boolean
Imputable sur Feuille de temps

commercial_contactid int (Liste déroulante : Contact)
Contact Commercial

oncall_schedule_enable boolean
Avec gestion des astreintes

time_unit int (Liste déroulante : Unité de temps)
Unité de temps
Endpoint de récupération des valeurs: /application/entities/161/values/

main_employeeid int (Liste déroulante : Collaborateur)
Manager

invoiceable boolean
Facturable

commercial_employeeid int (Liste déroulante : Collaborateur)
Commercial

invoicing_time_unit int (Liste déroulante : Unité de temps)
Unité de temps pour la facturation
Endpoint de récupération des valeurs: /application/entities/161/values/

vatid int (Liste déroulante : Taux de TVA)
Taux de TVA
Endpoint de récupération des valeurs: /application/entities/1608/values/

invoicing_mode int
Mode de facturation

summary string (TEXT)
Description

costcenterid int (Liste déroulante : Centre de coût)
Centre de coût
Endpoint de récupération des valeurs: /application/entities/1620/values/

comments longtext
Commentaires

profitcenterid int (Liste déroulante : Centre de profit)
Centre de profit
Endpoint de récupération des valeurs: /application/entities/1625/values/

siteid int (Liste déroulante : Site)
Site
Endpoint de récupération des valeurs: /application/entities/214/values/

active boolean
Actif

loekz boolean
Supprimé

expense_accountid int (Liste déroulante : Compte Comptable)
Compte de charge
Endpoint de récupération des valeurs: /accounts

cdate datetime
Créé le

locationid int (Liste déroulante : Agence)
Agence

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

udate datetime
MàJ le

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

versi int
Version

divisionid int (Liste déroulante : Zone d'intervention)
Zone d'intervention
Endpoint de récupération des valeurs: /application/entities/104/values/

industry int (Liste déroulante : Secteur d'activité)
Secteur d'activité
Endpoint de récupération des valeurs: /application/entities/143/values/

departmentid int (Liste déroulante : Service)
Service
Endpoint de récupération des valeurs: /application/entities/103/values/

last_activityid int (Liste déroulante : Activité)
Dernière action

last_action_on datetime
Dernière action le

invoicing_modeid int (Liste déroulante : Modalité de facturation)
Modalité de facturation
Endpoint de récupération des valeurs: /application/entities/219/values/

last_email_sent_on datetime
Dernier e-mail envoyé le

last_email_received_on datetime
Dernier e-mail reçu le

last_phone_call_on datetime
Dernier appel le

last_phone_successful_call_on datetime
Dernier appel réussi le

last_meeting_on datetime
Dernier meeting le

last_meeting_minute_on datetime
Dernier compte rendu le

taskid int (Liste déroulante : Tâche)
Dernière Tâche
Endpoint de récupération des valeurs: /application/entities/60/values/

nb_of_tasks int
Nb. de tâches

nb_of_open_tasks int
Nb. de tâches en cours

last_survey_modelid int (Liste déroulante : Questionnaire)
Questionnaire
Endpoint de récupération des valeurs: /application/entities/1008/values/

last_survey_on datetime
Dernier questionnaire le

inline_suppliers string
Contacts Fournisseurs

ENDPOINTS

Liste des projets

REQUEST

GET /projects

RESPONSE

200 OK

Créer un nouveau projet

REQUEST

POST /projects

RESPONSE

200 OK

Récupérer un projet

Path params

Projectid (int)
Identifiant d'un projet

REQUEST

GET /projects/{projectid}

RESPONSE

200 OK

Activité

Overview

Attributes

projectid int (Liste déroulante : Projet)
Projet

type int (Liste déroulante : Type)
Type
Endpoint de récupération des valeurs: /application/entities/805/values/

label string
Libellé

reference string
Référence

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

external_reference string
Réf. Externe

start_on datetime
Début le

assign_to_entities string
Visible par (Cibles)

end_on datetime
Fin le

ts_enable boolean
Imputable sur Feuille de temps

invoiceable boolean
Facturable

price double
Prix

time_unit int (Liste déroulante : Unité de temps)
Unité de temps pour l'imputation
Endpoint de récupération des valeurs: /application/entities/161/values/

initial_forecast double
Prévisionnel Initial

quantity_forecast float
Quantité Prévue (J)

unit int (Liste déroulante : Unité)
Unité
Endpoint de récupération des valeurs: /application/entities/1510/values/

currency int (Liste déroulante : Devise)
Devise
Endpoint de récupération des valeurs: /application/entities/9/values/

unitary_cost double
Coût unitaire

cost double
Coût

cost_increase boolean
Majoration des coûts

ordered_quantity float
Quantité Commandée (J)

cost_increase_detail string
Majoration des coûts détail

catalogid int (Liste déroulante : Catalogue)
Catalogue

materialid int (Liste déroulante : Produit)
Produit

assignment_type int
Visible par

description string (TEXT)
Description

udate datetime
MàJ le

timeslots string
Plages Horaires

ts_total_in_day float
Total imputé (J)

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

ts_total_in_min int
Total imputé (min)

ts_validated_total_in_day float
Total imputé validé (J)

ts_validated_total_in_min int
Total imputé validé (min)

ts_not_invoiceable_total_in_day float
Total imputé non facturable (J)

ts_not_invoiceable_total_in_min int
Total imputé non facturable (min)

ENDPOINTS

Liste des activités

REQUEST

GET /projectItems

RESPONSE

200 OK

Créer une nouvelle activité

REQUEST

POST /projectItems

RESPONSE

200 OK

Récupérer une activité

Path params

Itemid (int)
Identifiant d'une activité

REQUEST

GET /projectItems/{itemid}

RESPONSE

200 OK

Tâche Plannifiée

Overview

Attributes

paid int
ID Système

projectid int (Liste déroulante : Projet)
Projet

ticketid int (Liste déroulante : Ticket)
Ticket

itemid int (Liste déroulante : Activité)
Activité

level int
Niveau

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

assign_to_employeeid int (Liste déroulante : Collaborateur)
Assigné à

assign_to_contactid int (Liste déroulante : Contact)
Assigné à

initial_forecast float
Estimation Initiale (Jh)

forecast float
Estimation Actuel (Jh)

assign_to_name longtext (multiple)
Assigné à

planned float
Planifiée (J)

assign_to_entityid int (Liste déroulante : Entité)
Assigné à (Id Entité)
Endpoint de récupération des valeurs: /application/entities/2/values/

remaining float
RàF (J)

forecast_udate datetime
Estimation Actuel (MàJ le)

assign_to_objectid string
Assigné à (Id)

remaining_udate datetime
RàF MàJ le

done float
Réalisée (J)

start_date datetime
Début le

comments string (TEXT)
Commentaires

nb_of_sub_tasks int
Nb. de sous-tâche

end_date datetime
Fin le

start_time string
Heure de début

distribution_by_days string
Répartition par jours

end_time string
Heure de fin

ENDPOINTS

Liste des tâches plannifiées

REQUEST

GET /planActivities

RESPONSE

200 OK

Créer une nouvelle tâche plannifiée

REQUEST

POST /planActivities

RESPONSE

200 OK

Récupérer une tâche plannifiée

Path params

PlanActivityid (int)
Identifiant d'une tâche plannifiée

REQUEST

GET /planActivities/{planactivityid}

RESPONSE

200 OK