Skip to content

Support / Ticket

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.

Ticket

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/1812/values/


reference string
Référence


tags int (Liste déroulante : Tag)
Tag
Endpoint de récupération des valeurs: /application/entities/1843/values/


reported_by_name longtext (multiple)
Rapporté par


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


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


date datetime
Date


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


estimate_duedate datetime
Date Cible


duedate datetime
Date de livraison


desired_duedate datetime
Date livraison (Souhaitée)


reported_by_email string (CHAR255)
Rapporté par (Email)


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


severityid int (Liste déroulante : Criticité)
Criticité
Endpoint de récupération des valeurs: /application/entities/1815/values/


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


external_reference string
Réf. Externe


subject string
Sujet


description string (TEXT)
Description


cdate datetime
Créé le


udate datetime
MàJ le


systemid int (Liste déroulante : Système Informatique)
Système Informatique
Endpoint de récupération des valeurs: /application/entities/815/values/


complexity int (Liste déroulante : Complexité)
Complexité
Endpoint de récupération des valeurs: /application/entities/1820/values/


time_spend float
Temps passé


amount_flat double
Montant au forfait


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


time_spend_cost double
Montant (Temps passé)


amount_quotation double
Montant devis


assetid int (Liste déroulante : Equipement)
Equipement
Endpoint de récupération des valeurs: /application/entities/98/values/


amount_extra double
Coûts additionnels


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


amount double
Montant Total


time_spend_quotation float
Nb. Jours Devis


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


invoicing_mode int (Liste déroulante : Mode)
Mode
Endpoint de récupération des valeurs: /application/entities/1838/values/


amount_invoiced double
Montant facturé


parentid int (Liste déroulante : Ticket)
Ticket Parent


first_closed_on datetime
1ère Clôture le


closed_on datetime
Clôturé le


messageid int
Id Message


ticketid int
ID Système


boxid int (Liste déroulante : Boite Mail)
Boite Mail
Endpoint de récupération des valeurs: /application/entities/1090/values/


customerid int (Liste déroulante : Compte)
Compte


invoicing_state int (Liste déroulante : Etat)
Etat
Endpoint de récupération des valeurs: /application/entities/1511/values/


invoice_references longtext (multiple)
Factures


desired_duedate_time string
Heure de livraison (Souhaitée)


estimate_duedate_time string
Heure Cible


time_spend_initial_forecast string
Estimation


time_spend_current_forecast string
RàF


materialid int (Liste déroulante : Produit)
Produit


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


supplierid int (Liste déroulante : Fournisseur)
Fournisseur


reported_by_objectid string
Rapporté par (Id)


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


assign_to_objectid string
Assigné à (Id)


assign_to_email string (CHAR255)
Assigné à (Courriel)


orderid int (Liste déroulante : Commande)
Commande


order_reference string
N° Commande


order_external_reference string
Commande Réf. Externe


inline_files string
Pièces Jointes


nb_of_files int
Nb de Pièces Jointes

Liste des tickets

REQUEST

GET /tickets

RESPONSE

200 OK


Créer un nouveau ticket

REQUEST

POST /tickets


RESPONSE

200 OK


Récupérer un ticket

Path params


Ticketid (int)
Identifiant d'un ticket

REQUEST

GET /tickets/{ticketid}

RESPONSE

200 OK


Evènement

Overview

Attributes


eventid int
ID Système


ticketid int (Liste déroulante : Ticket)
Ticket


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


has_attachment boolean
Avec Pièces Jointes ?


message longtext
Message


templateid int (Liste déroulante : Template d'email)
Template d'email
Endpoint de récupération des valeurs: /application/entities/1100/values/


projectid int (Liste déroulante : Evènement)
Evènement


cdate datetime
Créé le


created_by string
Auteur (Nom)


created_by_email string (CHAR255)
Auteur (Email)


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


udate datetime
MàJ le

Liste des evènements

REQUEST

GET /ticketEvents

RESPONSE

200 OK


Créer un nouveau evènement

REQUEST

POST /ticketEvents


RESPONSE

200 OK


Récupérer un evènement

Path params


Eventid (int)
Identifiant d'un evènement

REQUEST

GET /ticketEvents/{eventid}

RESPONSE

200 OK


Temps passé par statut

Overview

Attributes


ticketid int (Liste déroulante : Ticket)
Ticket


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


date datetime
Date


ellapsed_openhours string
Durée en jours ouvrés


ellapsed string
Durée


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

Liste des temps passé par statut

REQUEST

GET /ticketStatusTimes

RESPONSE

200 OK


Créer un nouveau temps passé par statut

REQUEST

POST /ticketStatusTimes


RESPONSE

200 OK


Récupérer un temps passé par statut

Path params


Timeid (int)
Identifiant d'un temps passé par statut

REQUEST

GET /ticketStatusTimes/{timeid}

RESPONSE

200 OK


Log changement de statut

Overview

Attributes

Liste des log changement de statut

REQUEST

GET /ticketStatusLogs

RESPONSE

200 OK


Créer un nouveau log changement de statut

REQUEST

POST /ticketStatusLogs


RESPONSE

200 OK