API API Management
Transcript of API API Management
CATALOGUE DES API COLAS API – API Management
CELLULE ARCHITECTURE ET REFERENTIELS
COLAS DIGITAL SOLUTIONS
01/09/2020
1
Table des matières
Introduction ............................................................................................................................................. 3
1. Objet du document ..................................................................................................................... 3
2. Conventions et utilisation du document ................................................................................... 3
Liste des APIs : ........................................................................................................................................ 4
Domaine : Master Datas / Référentiels ................................................................................................ 5
1. BU : Business Units .................................................................................................................... 5
2. Les Structures ............................................................................................................................. 7
a. ERT .......................................................................................................................................... 7
b. SJ: Sociétés Juridiques ........................................................................................................... 7
c. UE : Unité d’exploitation ......................................................................................................... 8
d. UP : Unités de Production ...................................................................................................... 9
3. Employés ................................................................................................................................... 10
4. Equipements ............................................................................................................................. 11
5. Jobs/Chantiers ......................................................................................................................... 11
6. Utilisateurs et Applications ...................................................................................................... 13
7. Sites/Locations ......................................................................................................................... 13
Domaine : Travaux ................................................................................................................................ 15
1. Planification .................................................................................................................................. 15
a. Chantiers Planifiés ............................................................................................................... 15
b. Affectation d’une ressource ................................................................................................. 16
c. Besoin pour un chantier planifié ......................................................................................... 18
Domaine : Industrie .............................................................................................................................. 19
1. Client / Customer (Industrie) ................................................................................................... 19
2. Appels de livraison / DeliveryCall ............................................................................................ 20
3. Bon de livraison / Delivery Note ............................................................................................. 20
4. Dépôts ....................................................................................................................................... 21
5. Produits Industrie / Industry Products .................................................................................... 22
6. Chantiers / Jobs Zéphyr ........................................................................................................... 23
7. Produits de Ventes / Sales Products ...................................................................................... 24
8. Sites Industrie ........................................................................................................................... 25
9. Magasins Industrie ................................................................................................................... 25
10. Structures Industrie .............................................................................................................. 26
a. Unité d’exploitation : UE Zéphyr .............................................................................................. 26
11. Véhicules ............................................................................................................................... 26
a. Véhicules ............................................................................................................................... 26
b. Type de Véhicules / VehiculeType ....................................................................................... 27
2
c. Mise en attente Véhicule / PendingVehicule...................................................................... 28
12. Commandes Techniques Zéphyr (Obsolète avec la V2) .................................................... 29
Domaine : Achats ................................................................................................................................. 31
1. Fournisseurs ............................................................................................................................. 31
2. Bon de Commande (Purchase Order) ..................................................................................... 31
Domaine : Finance ............................................................................................................................... 32
1. Factures .................................................................................................................................... 32
2. IBAN ........................................................................................................................................... 32
Domaine : RH ........................................................................................................................................ 33
3. Collaborateurs .......................................................................................................................... 33
4. Informations Collaborateurs .................................................................................................... 33
Domaine : Réglementaires/MLV (Master List Of Values) .................................................................. 35
1. Listes des Réglementaires diffusés via API ............................................................................ 35
Domaine : APIs de Service ................................................................................................................... 37
1. CANT .......................................................................................................................................... 37
2. ColfluxPublic ............................................................................................................................. 38
a. Flux ........................................................................................................................................ 38
b. Parc Colflux ........................................................................................................................... 38
c. Structures ............................................................................................................................. 39
3. DocTec....................................................................................................................................... 39
4. E-Contract ................................................................................................................................. 39
5. MFA Authentification ................................................................................................................ 40
3
Introduction
1. Objet du document
L’objectif de ce document est de fournir le catalogue des APIs COLAS exposées sur l’APIM.
L’API Management est le processus de publication, de promotion et de supervision des APIs dans
un environnement sécurisé.
L’APIM est le point de mise à disposition de nos APIs « publiques ».
Par définition une API « publique » expose ses données sans connaître, à priori, le consommateur.
Ce document n’a pas pour but de définir les règles de développement des web APIs exposées par
les applications COLAS.
Ces règles sont explicitées dans le document « Web API Development Guidelines ».
Lien :
https://colase4.sharepoint.com/:w:/r/sites/ged0001/_layouts/15/Doc.aspx?sourcedoc={dd85a
09a-47a3-429b-b062-175c53f3fc73}&action=default&mobileredirect=true
2. Conventions et utilisation du document
Les APIs décrites dans ce catalogue sont les APIs « publiques » exposées par les applications du
SI Colas à destination des consommateurs.
Les APIs techniques ou « privées » d’une application ne font pas l’objet de ce document. Par
exemple une API entre le back et le front d’une application qui n’a pas pour objectif d’être utilisée
par une autre application.
Ce document est découpé en grands domaines fonctionnels dans lesquels sont réparties les
différentes ressources auxquelles les APIs permettent l’accès.
Pour chaque ressource on trouve :
- Une définition, principalement pour les Masters Datas
- Une description de ce que permet la méthode
- Les paramètres d’entrée
- Le nom de l’API et le nom de la méthode.
Ce document n’a pas pour vocation de remplacer les swaggers fournis par les développeurs et
retranscrits dans l’APIM. Les caractéristiques techniques, les paramètres d’entrées (type,
contraintes techniques, …) et les réponses retournées sont indiquées dans l’APIM.
APIM : https://apiportal.colas.com/
APIM E2 : https://newapie2portal.colas.com/
4
Liste des APIs :
APIs Version Domaine Balises
BUs V1/V2 MasterData Structure, BU
Cant V1 Service Notifications
Coupa Console V1 Achats Fournisseurs
EDispatch V1
V2
Travaux Planification,
Chantier, tâche journalière,
Affectation d’une ressource
Chantiers Planifiés
Jobs V2 MasterData Chantier, Job
Employees V2 MasterData Collaborateur, Employee
Equipments V2 MasterData Equipement
HRA V1 RH Collaborateur, Photo
SelfHRA V1 RH
MDMColasAPIs V1
Docapost V1
MasterData Produits
Supplier, Fournisseur
UsersDirectory V1 MasterData User, Utilisateur, Droits, Applications
StructuresDirectory V1 MasterData Structures
ERT, SJ, UE, UP
Zephyr V2
V1 (Obsolète)
Industrie Industrie
Client, Appel de livraison, Bon de
livraison, Dépôts, Produits industrie,
Chantiers Zéphyr, Produits de ventes,
Site Industrie, Structure Industrie (UE
Industrie), Véhicule, Commandes
5
Domaine : Master Datas / Référentiels
APIs Version Domaine Balises
BUs V1/V2 MasterData Structure, BU
Jobs V2 MasterData Chantier, Job
Employees V2 MasterData Employee, Collaborateur, Personnel
Equipments V2 MasterData Equipement
MDMColasAPIs V1
Docapost V1
MasterData Produits
Supplier, Fournisseur
UsersDirectory V1 MasterData User, Utilisateur, Droits, Applications
StructuresDirectory V1 MasterData Structures
ERT, SJ, UE, UP
MDM Locations V1 MasterData Sites/Locations
1. BU : Business Units
Définition :
La Business Unit (BU) est la clé de voûte de la structure analytique et du reporting. Elle est le
premier élément de la clé de compte.
Il existe plusieurs types de BU : • BU Bilan commune à toutes les UE d’une SJ
• BU Bilan réservée à l’UE siège
• BU industries (décomposées en activité niveau 1):
o Q : Carrière et décharges
o P : Postes
o B : Béton
o M : Autres industries
o T : Négoce
• BU Construction (décomposées en niveau 1):
o C : Travaux
o R : Ferroviaire
o W : étanchéité
• BU Services (décomposées en niveau 1 ou 2):
o S : Services
o Support :
▪ LA : branche personnelle (niveau 1 = L)
▪ EQ : équipement (niveau 1 = E)
▪ AD : Administration (niveau 1 = A).
Remarque : Une BU (autre que Bilan) appartient à une activité de niveau 2. Le réglementaire des Activités,
transverse à la comptabilité et au reporting, est composé d’un arbre à 3 niveaux. Le niveau 1 : Q,
P… (voir ci-dessus) est le père du niveau 2 de la BU.
Les BU « Construction » se décomposent encore en deux familles :
6
• Spécifique ou mono-affaire. Ces BU sont décomposées en phases. Elles concernent
notamment les affaires IAS (mais pas seulement).
• Générique ou multi-affaire. Ces BU contiennent deux phases PH=Recettes/PH00=Dépenses
Les BU Industries sont décomposées en Sous-Phase. A chacune de ces sous-phases, on associe
une phase (choisie dans une liste de valeurs). On retrouve donc un code phase dans plusieurs
BU, en revanche les sous-phases sont uniques.
La codification d’une BU est harmonisée sur 12 caractères : - SJ (5 caractères) Pour la BU Bilan commune à toutes les UE, il n’y aura que ces 5 caractères
- Code non mnémonique de l’UE à l’intérieur de la SJ (2 caractères) Pour la BU Bilan réservée à
l’UE siège, il n’y aura que ces 7 caractères
- Code identifiant de l’activité niveau 2 (2 caractères), le 1er caractère est le niveau 1
- Numéro chrono alphanumérique (3 caractères)
Cas particulier : les 5 derniers caractères sont EQUIP pour la BU Equipement et LABOR pour la BU
Personnel.
Les BU sont rattachées à l’UE. Exception pour la BU Bilan commune à toutes les UE d’une SJ qui
est rattachée à la SJ.
Une UE a au maximum une seule BU personnel et une seule BU Equipement.
Méthodes :
- Trouver une BU via son Identifiant
Cette méthode permet d’obtenir grâce à son identifiant, une BU et ses attributs.
L’identifiant nécessaire est l’identifiant de l’ERP, il est attribué à la création de la BU et est
unique.
Si l’on ne connait pas l’identifiant mais que l’on connait d’autres informations on peut utiliser la
seconde méthode permettant de rechercher des BUs via différents critères de recherche.
API: BUV2
Méthode: Returns a BU whose id is passed as an argument
- Obtenir une liste de Business Units selon des critères de recherche :
Cette méthode permet d’obtenir grâce à un ou plusieurs critères de recherche une liste de BUs
correspondantes.
Les critères que l’on peut utiliser pour la recherche sont les suivants :
o Activité de Niveau 2 (ActivityLevel2) : Activité niveau 2 du NRA
o Actif (IsActive) : les BUs recherchés sont actifs ou non.
o Générique (IsGeneric) : Les BUs recherchées sont des BUs génériques ou non
(pour les BUs Travaux)
o Unité de Production (up) : Unité de production des Business Units recherchées, on
utilise l’identifiant normalisé (UP867) ou l’identifiant légal (CMM254).
o Unité d’exploitation (ue) : Unité d’exploitation des Business Units recherchées, on
utilise l’identifiant normalisé (UE440) ou l’identifiant légal (CMM05017TR).
o Société Juridique (sj) : Société Juridique des Business Units recherchées, on
utilise l’identifiant normalisé (SJ197) ou l’identifiant légal (COLMM).
Au moins un des critères doit être fourni pour utiliser la méthode.
Si de nombreuses BUs sont trouvées, le nombre de pages et le nombre de BUs par page sont
indiquées et ces paramètres peuvent servir de critères de recherche dans la requête.
7
API: BUV2
Méthode: Returns a BU list whose search criterias are passed as argument
2. Les Structures
Définition des Structures :
Une structure est une entité de l’organisation de COLAS dotée de ressources (humaines,
matérielles et financières), d’un management et d’objectifs propres.
Les structures sont partagées entre les différentes applications du SI pour permettre les
échanges entre applications et notamment la consolidation cohérente, dans le décisionnel et le
reporting, des données produites par les différents domaines.
API : StructuresDirectory
a. ERT
Définition :
ERT signifie Entité de Reporting de Tête.
Il s’agit d’un niveau de regroupement d’une ou plusieurs SJ sur un territoire donné,
correspondant à un niveau de management.
Méthodes :
- Obtenir les informations d’une ERT par son Identifiant
Cette méthode permet d’obtenir l’ensemble des informations d’une ERT en donnant l’identifiant
normalisé (exemple : ERT12).
Méthode : GET request that return the Iris_ERT element that match the given ERTId
- Obtenir un ensemble d’ERT selon des coordonnées GPS
…………………….. [Problème Technique]
Cette méthode permet d’obtenir toutes les ERT et leurs attributs selon une position GPS donnée.
En fournissant les coordonnées (latitude, longitude) et un périmètre (radius) autour de ces
coordonnées, on obtient la liste des ERT et leurs attributs se situant dans ce périmètre.
Méthode : GET request that return all Iris_ERT elements that match the given GPS position
(latitude, longitude) and radius
b. SJ: Sociétés Juridiques
Définition :
Les Sociétés Juridiques sont un élément du système et permettent notamment la consolidation
des données du reporting.
Une SJ appartient à une ERT et est la somme d’un nombre d’UE.
Une société juridique appartient à 1 pays et a une existence légale indépendamment de Colas.
Cette société du groupe Colas est identifiée en France par un SIREN, en Europe par un code TVA
Intracom, à l’international par exemple par un code DUNS.
8
Méthodes:
- Obtenir les informations d’une SJ par son identifiant
Cette méthode permet d’obtenir l’ensemble des informations d’une SJ en donnant l’identifiant
normalisé (exemple : SJ234)
Méthode: GET request that return the Iris_SJ element that match the given SJId
- Obtenir l’ensemble des SJ appartenant à une ERT donnée
En fournissant l’identifiant normalisé d’un ERT, on obtient la liste des SJ de cet ERT.
[Méthodes disponibles sur Structures => ERT]
Le résultat est l’ensemble des SJ de cet ERT ainsi que leurs attributs.
Parmi les attributs d’une SJ on trouve les attributs de son parent (ERT => SJ).
Méthode: GET request that return all Iris_SJ elements that contain the given ERTId
- Obtenir un ensemble de SJ selon des coordonnées GPS
…………………….. [Problème Technique]
Cette méthode permet d’obtenir toutes les SJ selon une position GPS donnée.
En fournissant les coordonnées (latitude, longitude) et un périmètre (radius) autour de ces
coordonnées, on obtient la liste des SJ et leurs attributs se situant dans ce périmètre.
Méthode : GET request that return all Iris_SJ elements that match the given GPS position
(latitude, longitude) and radius
c. UE : Unité d’exploitation
Définition :
Il s’agit de la structure élémentaire de base, elle correspond à un établissement (agence de
travaux, carrière, poste, usine, atelier, laboratoire ou siège de filiale).
Il est rattaché à la Société Juridique.
Méthodes :
- Obtenir les informations d’une UE par son identifiant
Cette méthode permet d’obtenir l’ensemble des informations d’une UE en donnant l’identifiant
normalisé (exemple : UE1432)
Parmi les attributs d’une UE on trouve les attributs de ses parents (ERT => SJ => UE).
Méthode : GET request that return the Iris_UE element that match the given UEId
- Obtenir l’ensemble des UEs appartenant à une ERT donnée
En fournissant l’identifiant normalisé d’un ERT, on obtient la liste des UE de cet ERT.
[Méthodes disponibles sur Structures => ERT]
Le résultat est l’ensemble des UE de cet ERT ainsi que leurs attributs. Parmi les attributs d’une
UE on trouve les attributs de leurs parents (ERT => SJ => UE).
Méthode : GET request that return all Iris_UE elements that contain the given ERTId
- Obtenir l’ensemble des UEs appartenant à une SJ donnée
9
En fournissant l’identifiant normalisé d’une SJ, on obtient la liste des UE de cette SJ.
[Méthodes disponibles sur Structures => SJ]
Le résultat est l’ensemble des UE de cette SJ ainsi que leurs attributs. Parmi les attributs d’une
UE on trouve les attributs de ses parents (ERT => SJ => UE).
Méthode : GET request that return all Iris_UE elements that contain the given SJId
- Obtenir un ensemble d’UE selon des coordonnées GPS
…………………….. [Problème Technique]
Cette méthode permet d’obtenir toutes les UE selon une position GPS donnée.
En fournissant les coordonnées (latitude, longitude) et un périmètre (radius) autour de ces
coordonnées, on obtient la liste des UE et leurs attributs se situant dans ce périmètre.
Méthode: GET request that return all Iris_UE elements that match the given GPS position
(latitude, longitude) and radius
d. UP : Unités de Production
Définition :
Unité de Production (UP) : Structure élémentaire d’identification d’un site de production de
matériaux. Elle est toujours rattachée à une UE et doit être dotée d’un système de gestion
industriel (type Inedi, Zephyr, Industria)
Méthodes :
- Obtenir les informations d’une UP par son identifiant
Cette méthode permet d’obtenir l’ensemble des informations d’une UP en donnant l’identifiant
normalisé (exemple : UP1444)
Parmi les attributs d’une UP on trouve les attributs de ses parents (ERT => SJ => UE => UP).
Méthode : GET request that return the Iris_UP element that match the given UPId
- Obtenir l’ensemble des UP appartenant à une ERT donnée
En fournissant l’identifiant normalisé d’un ERT, on obtient la liste des UP présent dans cet ERT.
[Méthodes disponibles sur Structures => ERT]
Le résultat est l’ensemble des UP de cet ERT ainsi que leurs attributs. Parmi les attributs d’une
UP on trouve les attributs de ses parents (ERT => SJ => UE => UP).
Méthode : GET request that return all Iris_UP elements that contain the given ERTId
- Obtenir l’ensemble des UP appartenant à une SJ donnée
En fournissant l’identifiant normalisé d’une SJ, on obtient la liste des UP de cette SJ.
[Méthodes disponibles sur Structures => SJ]
Le résultat est l’ensemble des UP de cette SJ ainsi que leurs attributs. Parmi les attributs d’une
UP on trouve les attributs de ses parents (ERT => SJ => UE => UP).
Méthode : GET request that return all Iris_UP elements that contain the given SJId
- Obtenir l’ensemble des UP appartenant à une UE donnée
10
En fournissant l’identifiant normalisé d’une UE, on obtient la liste des UP de cette UE.
[Méthodes disponibles sur Structures => UE]
Le résultat est l’ensemble des UP de cette UE ainsi que leurs attributs. Parmi les attributs d’une
UP on trouve les attributs de ses parents (ERT => SJ => UE => UP).
Méthode : GET request that return all Iris_UP elements that contain the given UEId
- Obtenir un ensemble d’UP selon des coordonnées GPS
…………………….. [Problème Technique]
Cette méthode permet d’obtenir toutes les UP selon une position GPS donnée.
En fournissant les coordonnées (latitude, longitude) et un périmètre (radius) autour de ces
coordonnées, on obtient la liste des UP et leurs attributs se situant dans ce périmètre.
Méthode: GET request that return all Iris_UP elements that match the given GPS position
(latitude, longitude) and radius
3. Employés
Définition :
On distingue deux types de personnel : le personnel interne (les salariés du groupe) et le
personnel externe (les prestataires).
Pour la France, le référentiel maître pour le personnel interne est HRA.
Les dossiers du personnel interne sont extraits d’HRA et enregistrés dans JDE.
Le référentiel maître pour le personnel externe est JDE. Leur dossier n’existe pas dans HRA.
API : Employees v2
Méthodes :
- Trouver un employé via son Identifiant
Cette méthode permet d’obtenir grâce à son identifiant, un employé et ses attributs.
L’identifiant nécessaire est l’identifiant de l’ERP, il est attribué par JDE et est unique pour le
personnel externe et interne.
Si l’on connait d’autres informations que l’identifiant ERP on peut utiliser la seconde méthode
permettant de rechercher des employés via différents critères de recherche.
API: Employees V2
Méthode : GET Returns an Employee whose id is passed as an argument
- Obtenir une liste d’employés selon des critères de recherche :
Cette méthode permet d’obtenir grâce à un ou plusieurs critères de recherche une liste
d’employés correspondant.
Les critères que l’on peut utiliser pour la recherche sont les suivants :
o Nom de Famille (LastName) : Nom de famille de l’employé
o Actif (IsActive) : les employés recherchés sont actifs
o Identifiant de l’outil RH (LocalId) : Identifiant de l’employé dans l’outil RH local,
HRA pour la France par exemple.
o Unité d’exploitation (ue) : Unité d’exploitation des employés recherchés
[Méthodes disponibles sur Structures => UE]
11
o Société Juridique (sj) : Société juridique des employés recherchés
[Méthodes disponibles sur Structures => SJ]
Au moins un des critères doit être fourni pour utiliser la méthode.
Si de nombreux employés sont trouvés, le nombre de pages et le nombre d’employés par page
sont indiqués et ces paramètres peuvent servir de critères de recherche dans la requête.
Méthode: GET Returns an Employee list whose search criterias are passed as arguments
4. Equipements
Le référentiel maître pour les équipements (ou matériels) est JDE.
Un équipement est identifié par son code Euroliste.
Ces APIs vont permettre de récupérer les informations sur les équipements utilisées, notamment
pour le pointage mais aussi des informations sur l’indisponibilité actuelle ou future du matériel.
API: Equipments v2
Méthodes:
- Trouver un équipement via son Identifiant
Permet d’avoir les informations d’un équipement par son Identifiant.
Cet identifiant est le code Euroliste de l’équipement.
Méthode :
- Obtenir une liste d’équipements selon des critères de recherche
Cette méthode permet d’obtenir grâce à un ou plusieurs critères de recherche une liste
d’équipements correspondant.
Les critères que l’on peut utiliser pour la recherche sont les suivants :
o Actif (IsActive) : les équipements recherchés sont actifs
o Identifiant Technique JDE (jdeTechId)
o Marque (brand) : Marque de l’équipement
o Type (type) : Type de l’équipement sur la carte grise
o Numéro de plaque (plateNumber) : Immatriculation de l’équipement
o Segmentation Analytique (analyticalSegmentation)
o Unité d’exploitation (ue) : Unité d’exploitation des équipements recherchés
[Méthodes disponibles sur Structures => UE]
o Société Juridique (sj) : Société juridique des équipements recherchés
[Méthodes disponibles sur Structures => SJ]
Au moins un des critères doit être fourni pour utiliser la méthode.
Si de nombreux équipements sont trouvés, le nombre de pages et le nombre d’équipements par
page sont indiqués et ces paramètres peuvent servir de critères de recherche dans la requête.
Méthode :
5. Jobs/Chantiers
12
API : Jobs V2
Méthodes :
- Obtenir la liste des chantiers ;
Cette méthode permet d’obtenir la liste de l’ensemble des chantiers ainsi que leurs attributs.
Méthode: GET Returns a List of Job
- Obtenir un chantier et ses informations via son identifiant
Permet d’avoir les informations d’un chantier par son Identifiant.
Cet identifiant peut être l’identifiant MDM (MdmId) ou l’identifiant ERP (identifier).
Méthode : GET Returns a Job whose id is passed as an argument
- Obtenir une liste de chantiers selon des critères de recherche
Cette méthode permet d’obtenir grâce à un ou plusieurs critères de recherche une liste de
chantiers correspondants.
Les critères que l’on peut utiliser pour la recherche sont les suivants :
o Actif (IsActive) : les chantiers recherchés sont actifs ou non
o Identifiant Local (localId) : Identifiant du chantier dans le système local (E-
Contract)
o Unité d’exploitation (ue) : UE des chantiers recherchés
[Méthodes disponibles sur Structures => UE]
o Société Juridique (sj) : SJ des chantiers recherchés
[Méthodes disponibles sur Structures => SJ]
o Identifiant MDM (mdmId) : Identifiant du chantier dans le MDM
o Ville (City) : Ville du chantier
o Adresse (addressLine) : les lignes adresses 1 et 2 de l’adresse du chantier
recherché
o Statut (Status) : Statut du chantier recherché
o Chef de Chantier (Foreman) : Chef de chantier du ou des chantiers recherchés
o Conducteur de Travaux (contractManager) : Conducteur de travaux du ou des
chantiers recherchés
o AllForeman : Si vrai, permet de retrouver tous les chantiers pour lequel le chef de
chantier déclaré dans le paramètre Foreman est chef de chantier principal mais
aussi ceux pour lesquels il est chef de chantier additionnel. Autrement sont
seulement pris en compte les chantiers pour lesquels il est chef de chantier
principal.
o AllContractManager : Si vrai, permet de retrouver tous les chantiers pour lequel le
conducteur de travaux déclaré dans le paramètre Foreman est conducteur
principal mais aussi ceux pour lesquels il est conducteur additionnel. Autrement
sont seulement pris en compte les chantiers pour lesquels il est conducteur de
travaux principal.
Au moins un des critères doit être fourni pour utiliser la méthode.
Si de nombreux chantiers sont trouvés, le nombre de pages et le nombre de chantiers par page
sont indiqués et ces paramètres peuvent servir de critères de recherche dans la requête.
Méthode: Returns a Job list whose search criterias are passed as arguments
13
6. Utilisateurs et Applications
Ces APIs permettent d’obtenir des informations sur les utilisateurs, leurs droits et les applications
du système d’information
API : UsersDirectory
- Obtenir les applications du SI :
Cette méthode permet d’obtenir l’ensemble des applications du SI et leurs attributs (Code de
l’application, Web ou non, Externe ou non, URL de l’application).
On peut obtenir soit l’ensemble des applications soit certaines applications selon des critères de
recherche :
o Active (enabled) : l’application est active ou non dans le SI
o Web (isWeb) : l’application est une application web ou non
o Adaptable (isAdaptvie) : l’application est adaptable ou non
o Externe (hasExternalAccess) : l’application est accessible via l’extérieur du SI
Méthode : Returns properties of applications - Retourne les propriétés des applications
- Obtenir les utilisateurs d’une application :
Cette méthode permet d’obtenir tous les utilisateurs d’une application par le code de
l’application.
Si on ne connait pas le code de l’application désirée, on peut utiliser la méthode précédente
(Obtenir les applications du SI).
Méthode : Returns the users of an application by its code - Retourne les utilisateurs d'une
application par son code
- Obtenir les applications (et le profil) d’un utilisateur :
Cette méthode permet d’obtenir toutes les applications d’un utilisateur par son Login.
Le résultat de cette méthode nous fournit les attributs de l’utilisateur et les applications de celui-
ci ainsi que son profil pour chacune d’elle.
Méthode : Returns the applications of a user by his login - Retourne les applications d'un
utilisateur par sa signature
- Savoir si un utilisateur a les droits sur une application :
Cette méthode permet de savoir si un utilisateur donné à les droits sur une application donnée.
Pour cela on fournit le login de l’utilisateur et le code de l’application, on obtient une réponse
« true » ou « false ».
Méthode : Return true if user authorized for an application - Retourne vrai si un utilisateur est
autorisé pour une application
7. Sites/Locations
Le référentiel maître pour les sites est le portail référentiel (Hubble).
Il s’agit du référentiel des sites physiques (hors chantiers) de COLAS.
Un site (ou site physique) est un lieu géographique sur lequel Colas est, a été installé ou prévoit
de s’installer, que du personnel y soit présent ou pas, et que ce site soit possédé, concédé ou
14
loué. En général, un site engage la responsabilité de Colas (assurances, contraintes
environnementales, …). Un site a une adresse physique et des coordonnées GPS et peut
héberger une ou plusieurs structures de Colas.
- Trouver un site via son Identifiant
Permet d’avoir les informations d’un site par son Identifiant.
Cet identifiant est l’ID fourni lors de la création d’un site par le référentiel.
API: MdmColas APIs Locations V1
Méthode: GET Return a location by its ID.
- Obtenir l’ensemble des sites
Cette méthode permet d’obtenir la liste de l’ensemble des sites physiques actifs de COLAS.
La réponse à cette méthode est la liste des sites paginée.
le nombre de pages et le nombre de sites par page sont indiqués et ces paramètres peuvent
servir de critères de recherche dans la requête.
API: MdmColas APIs Locations V1
Méthode: GET Searchl ocations (AllActives).
- Obtenir une liste de sites selon des critères de recherche
Cette méthode permet d’obtenir grâce à un ou plusieurs critères de recherche une liste de sites.
Les critères que l’on peut utiliser pour la recherche sont les suivants :
o FreeSearch : Permet une recherche libre sur les noms de sites
o Country : Recherche par pays, code ISO du pays.
[Méthodes disponibles sur MLV => Country]
o MdmId : Identifiant du Site.
o Name : Nom du site
o Address : Recherche sur l’adresse du site
o StructureId : Identifiant de la structure Colas présente sur le site.
o ContactLogin : Login du contact présent sur le site.
o Statuses : Statut du Site => « ACTIVE », …
[Méthodes disponibles sur Mdm Locations => LocationStatus]
o Types : Type de site, renseigner le code du type de sites.
[Méthodes disponibles sur Mdm Locations => LocationType]
Si de nombreux sites sont trouvés, le nombre de pages et le nombre de sites par page sont
indiqués.
API: MdmColas APIs Locations V1
Méthode: GET Search locations (FreeSearch).
15
Domaine : Travaux
APIs Version Domaine Balises
EDispatch V1 Travaux
V2 Travaux Chantiers Planifiés
API EDispatch V1 :
Certaines méthodes actuellement affichées sur l’APIM sont obsolètes et ne seront pas décrites
dans ce document.
Méthodes obsolètes : Ensemble des méthodes sous la balise « DailyJobAPI »
On trouve les mêmes méthodes redéveloppées afin de coller à la philosophie REST sous la balise
« PlanningAPI ».
De plus les APIs sous la balise « BusinessProbCheckAPI » sont des APIs techniques et ne seront
pas décrites dans ce document.
1. Planification
a. Chantiers Planifiés
- Obtenir la liste des chantiers planifiés
Cette méthode permet de récupérer l’ensemble des chantiers planifiés.
Il est possible d’utiliser certains critères afin d’affiner la liste des chantiers retournée.
Les critères que l’on peut utiliser pour la recherche sont les suivants :
o foremanLogin : login du chef de chantier pour lequel on veut trouver les
chantiers planifiés.
o startDate : Date de départ pour laquelle on veut chercher les chantiers
planifiés (par défaut : date du jour).
o endDate : Date de fin de recherche. Si celle-ci n’est pas définie, on prend la
date de départ +14 jours. Par raison de performances le delta entre la date de
départ et la date de fin ne peut excéder 14 jours.
o planningType : Type du planning, 1 pour Hebdomadaire, 2 pour Journalier.
Si le type n’est pas précisé, le planning journalier sera sélectionné.
o jobViewType : 1 pour mes chantiers, 2 pour les autres.
Si le type n’est pas précisé, l’option « Mes Chantiers » sera sélectionnée.
API : EDispatch V2
Méthode : GET Returns the list of planned jobs.
API : EDispatch V1 [Obsolète à partir de la V2 Mars 2020]
Il se peut que certains critères de la V2 ne soient pas présents dans la V1.
La V1 doit être supprimée 6 mois après la mise en place de la V2.
Méthode : GET Returns the list of planned jobs
- Obtenir la liste des chantiers planifiés ainsi que les tâches qui lui sont
liées.
16
Cette méthode permet de récupérer l’ensemble des chantiers planifiés ainsi que les tâches qui
lui sont associées.
Les critères sont obligatoires et sont les suivants :
o ComputedDailyJobIdentifier : Identifiant du chantier journalier (Guid) pour un
planning journalier (Daily Planning) ou Computed Id pour le planning
hebdomadaire (Weekly planning).
Le Computed ID (Technique) est créé par EDispatch pour permettre l’affichage
en planning hebdo sur l’appli Mobile.
o JobIdentifier : Identifiant du chantier
o QueryDate : Date de la recherche, si celle-ci n’est pas précisée on utilise la
date du jour.
o planningType : Type du planning, 1 pour Hebdomadaire, 2 pour Journalier.
Si le type n’est pas précisé, le planning journalier sera sélectionné.
API: EDispatch V2
Méthode: GET Returns the list of planned activities with related tasks if any
API : EDispatch V1 [Obsolète à partir de la V2 Mars 2020]
Il se peut que certains critères de la V2 ne soient pas présents dans la V1.
La V1 doit être supprimée 6 mois après la mise en place de la V2.
Méthode : Returns the list of planned jobs with related tasks if any
- Obtenir la liste des chantiers journaliers planifiés pour un chantier donné
Cette méthode permet de récupérer la liste des identifiants des chantiers journaliers planifiés et
leurs dates en fournissant l’identifiant du chantier.
Chantier journalier :
Un chantier physique peut être planifié le matin et l’après-midi en deux chantiers journaliers
différents.
Il est possible de surcharger le libellé d’un chantier journalier par un alias.
Dans ce cas le chantier sera positionné le matin sous un certain alias et l’après-midi sous un
second.
Il y aura alors 2 chantiers journaliers pour le même chantier physique.
Pour cette méthode la recherche se fait sur une plage de temps de 30 jours.
API : EDispatch V1
Méthode : Returns the list of daily job Ids and dates for a given job identifier in a 30 days
timeframe.
- Obtenir la liste des chantiers journaliers et des tâches journalières
associées.
Cette méthode permet de récupérer l’ensemble des chantiers journaliers ainsi que ses tâches
journalières associées.
Il est possible de filtrer la recherche en utilisant le login du chef de chantier (foreman).
Dans ce cas on obtient seulement les chantiers journaliers associés à ce chef de chantier.
API : EDispatch V1
Méthode : Returns the list of jobs and associated daily tasks.
b. Affectation d’une ressource
17
• Affectation d’un employé
- Confirmer affectation d’un employé
Pour confirmer l’affectation d’un employé, il faut en utilisant cette méthode envoyer l’identifiant
de la tâche journalière associée.
API : EDispatch V1
Méthode: PATCH Confirms an employee assignment.
- Supprimer l’affectation d’un employé
Pour annuler l’affectation d’un employé, il faut en utilisant cette méthode envoyer l’identifiant de
la tâche journalière associée.
API : EDispatch V1
Méthode: DELETE Cancels an employee assignment.
- Modifier l’affectation d’un employé avec une quantité donnée
Cette méthode permet de modifier l’affectation d’un employé en modifiant la quantité, on modifie
alors avec la quantité donnée dans les paramètres de la méthode.
API : EDispatch V1
Méthode: POST Updates an employee assignment with a given quantity. Only generic employee
can be updated.
• Affectation d’un équipement
- Confirmer affectation d’un équipement
Pour confirmer l’affectation d’un équipement, il faut en utilisant cette méthode envoyer
l’identifiant de la tâche journalière associée.
API : EDispatch V1
Méthode: PATCH Confirms an equipment assignment.
- Supprimer l’affectation d’un équipement
Pour annuler l’affectation d’un équipement, il faut en utilisant cette méthode envoyer l’identifiant
de la tâche journalière associée.
API : EDispatch V1
Méthode: DELETE Cancels an equipment assignment.
- Modifier l’affectation d’un équipement avec une quantité donnée
Cette méthode permet de modifier l’affectation d’un équipement en modifiant la quantité, on
modifie alors avec la quantité donnée dans les paramètres de la méthode.
API : EDispatch V1
Méthode: POST Updates an equipment assignment with a given quantity. Only generic employee
can be updated.
• Affectation d’un Article/Item:
- Confirmer affectation d’un article
18
Pour confirmer l’affectation d’un article, il faut en utilisant cette méthode envoyer l’identifiant de
la tâche journalière associée.
API : EDispatch V1
Méthode: PATCH Confirms an item assignment.
- Supprimer l’affectation d’un article
Pour annuler l’affectation d’un article, il faut en utilisant cette méthode envoyer l’identifiant de la
tâche journalière associée.
API : EDispatch V1
Méthode: DELETE Cancels an item assignment.
- Modifier l’affectation d’un article avec une quantité donnée
Cette méthode permet de modifier l’affectation d’un article en modifiant la quantité, on modifie
alors avec la quantité donnée dans les paramètres de la méthode.
API : EDispatch V1
Méthode: POST Updates an item assignment with a given quantity. Only generic employee can be
updated.
c. Besoin pour un chantier planifié
- Envoyer un besoin au Dispatcheur d’un chantier
Cette méthode permet lorsque l’on a besoin de quelque chose pour un chantier planifié d’envoyer
une expression de ce besoin au Dispatcheur.
Pour cela il est nécessaire d’envoyer l’identifiant du chantier journalier (DailyJobId) ainsi que
demande est décrite dans une zone de texte.
API : EDispatch V1
Méthode : Sends a need to the Dispatcher of the job.
19
Domaine : Industrie
APIs Version Domaine Balises
Zephyr V2 Industrie Industrie
Client, Appel de livraison, Bon de livraison, Dépôts, Produits
industrie, Chantiers Zéphyr, Produits de ventes, Site
Industrie, Structure Industrie (UE Industrie), Véhicule
V1
(Obsolète)
Industrie Industrie
Client, Appel de livraison, Bon de livraison, Dépôts, Produits
industrie, Chantiers Zéphyr, Produits de ventes, Site
Industrie, Structure Industrie (UE Industrie), Véhicule,
Commandes
1. Client / Customer (Industrie)
- Obtenir des clients Zéphyr
Cette méthode permet :
- De récupérer la totalité des clients Zéphyr ainsi que leurs attributs.
- D’obtenir grâce à un ou plusieurs critères de recherche une liste de clients Zéphyr
correspondants, ainsi que leurs attributs.
Les critères que l’on peut utiliser pour la recherche sont les suivants :
o CodeUE : Code de l’Unité d’exploitation des clients souhaités.
[Méthodes disponibles sur Structures Industrie => UE Zephyr]
o Code : Code identifiant Zéphyr des clients souhaités.
o IdentifierJDE : Identifiant JDE des clients souhaités.
o IdentifierMDM : Identifiant MDM des clients souhaités.
o CompanyName : Raison Sociale des clients souhaités.
o ShortLabelJDE : Libellé court JDE des clients souhaités.
o LongLabelJADE : Libellé long JADE des clients souhaités
o SIRET : Numéro de SIRET des clients souhaités.
o SIREN : Numéro de SIREN des clients souhaités.
o TaxCode : Numéro de TVA Intracom des clients souhaités.
o Customer_CodeUE : Code de l’Unité d’exploitation de rattachement des clients
souhaités pour les clients COLAS.
o Sleep : Indique si l’on souhaite les clients en sommeil ou non. Si le critère n’est
pas spécifié, les clients sont tous retournés.
o SleepDate : Date spécifiée pour les clients en sommeil, si le critère n’est pas
spécifié ce sera la date du jour.
Les critères de recherche sont facultatifs.
API: Zephyr V2
Méthode : GET Récupère des clients Zéphyr
API : Zéphyr V1 [Obsolète depuis la V2]
Dans la V1, une méthode pour récupérer tous les clients et une méthode pour filtrer par critères.
Certains critères disponibles en V2 ne sont peut-être pas disponibles en V1
Méthode : GET Récupère tous les clients Zéphyr
Méthode : POST Récupère tous les clients Zéphyr filtrés par le critère de recherche fourni
20
2. Appels de livraison / DeliveryCall
- Obtenir un appel de livraison Zéphyr :
Cette méthode permet d’obtenir grâce au Code de l’UE et à son identifiant un appel de livraison
Zéphyr ainsi que ses attributs.
Les critères sont les suivants :
o CodeUE : Code de l’unité d’exploitation du site industrie
[Méthodes disponibles sur Structures Industrie => UE Zephyr]
o Identifier : Identifiant de l’appel de livraison Zéphyr à récupérer
Les critères sont obligatoires.
API : ZéphyrV2
Méthode : Récupère un appel de livraison Zéphyr
API : Zéphyr V1[Obsolète depuis la V2]
Méthode : POST Récupère tous appels de livraison Zéphyr filtrés par le critère de recherche
fourni
3. Bon de livraison / Delivery Note
- Obtenir les bons de livraison via l’UE :
Cette méthode permet d’obtenir grâce à un (le code UE) ou plusieurs critères de recherche une
liste des bons de livraison Zéphyr correspondants, ainsi que leurs attributs.
Les critères que l’on peut utiliser pour la recherche sont les suivants :
o CodeUE (Obligatoire) : Code de l’unité d’exploitation du site industrie où le BL a
été fait.
[Méthodes disponibles sur Structures Industrie => UE Zephyr]
o DeliveryNoteIdentifier : Identifiant du bon de livraison
o DeliveryCallIdentifier : Identifiant Zéphyr de l’appel de livraison à l’origine du BL
[Méthodes disponibles sur Appel de livraison / DeliveryCall]
o CodeSite : Code du site Zéphyr du bon de livraison
[Méthodes disponibles sur Site Zéphyr]
o CodeUP : Code technique de l’Unité de Production associé au site Zéphyr du bon
de livraison
o CodeDepot : Code du dépôt Zéphyr du bon de livraison
[Méthodes disponibles sur Industrie => Dépôts]
o CodeBU : Code de la business Unit associée au dépôt Zéphyr du bon de livraison
o CodeJob : Code Zéphyr du chantier
[Méthodes disponibles sur Chantier / Job Zéphyr]
o IdMdmJob : Identifiant MDM du chantier
[Méthodes disponibles sur Chantier / Job Zéphyr]
o CodeCustomer : Code Zéphyr du Client
[Méthodes disponibles sur Client / Customer (Industrie)]
o IdMdmCustomer : Identifiant MDM du client
[Méthodes disponibles sur Client / Customer (Industrie)]
o Foreman : Login du chef de chantier destinataire du bon de commande
o Registration : Immatriculation du véhicule
La recherche est aussi réalisée sur des critères de temps. Ici cela signifie le temps maximum
depuis lequel le bon de livraison a été créé :
21
o SearchPeriodMinutes : Nombre de minutes maximum depuis lesquelles le bon de
livraison a été créé (si ce critère n’est pas spécifié on utilise le critère
SearchPeriodHours)
o SearchPeriodHours : Nombre d’heures maximum depuis lesquelles le bon de
livraison a été créé (si ce critère n’est pas spécifié la valeur par défaut est 24h).
Le codeUE est un critère de recherche obligatoire.
API : Zephyr V2
Méthode : GET Récupère une liste de bons de livraison Zéphyr
API : Zéphyr V1 [Obsolète depuis la V2]
Certains critères disponibles en V2 ne sont peut-être pas disponibles en V1
Méthode : POST Récupère tous les bon de livraison Zéphyr filtrés par le critère de recherche
fourni
- Obtenir les bons de livraison triés par date :
Cette méthode permet d’obtenir une liste des bons de livraison Zéphyr correspondants, ainsi que
leurs attributs. Ici les bons de livraison ne sont pas filtrés sur une UE (Unité d’exploitation) et sont
triés par date, permettant d’avoir une liste priorisée des BLs.
Les critères que l’on peut utiliser pour la recherche sont les mêmes que la méthode précédente.
En complément il est possible de rechercher sur les critères suivants :
o dateDepart_Min : Date de départ minimum du véhicule
o dateDepart_Max : Date de départ maximum du véhicule
Contrairement à la méthode précédente, l’ensemble des critères sont facultatifs.
API : Zephyr V2
Méthode : GET Récupère une liste de bons de livraison Zéphyr centralisée dans le cache triée du
plus récent au plus vieux.
- Importer des données de bons de livraison dans Zéphyr // DeliveryData
Cette méthode permet l’import de BL dans Zéphyr, l’ensemble des données à fournir est décrit
dans le corps de la demande sur l’APIM.
API : Zephyr V2
Méthode : POST Import de données de bons de livraison dans Zéphyr
4. Dépôts
- Obtenir des dépôts Zéphyr :
Cette méthode permet :
- De récupérer la totalité des dépôts Zéphyr ainsi que leurs attributs.
- D’obtenir grâce à un ou plusieurs critères de recherche une liste de dépôts Zéphyr
correspondants, ainsi que leurs attributs.
Les critères que l’on peut utiliser pour la recherche sont les suivants :
o CodeDepot : Code du dépôt
o CodeUE : Code de l’Unité d’exploitation (mnémonique ou normalisé) du dépôt
[Méthodes disponibles sur Structures Industrie => UE Zephyr]
22
o CodeSite : Code du site Zéphyr du dépôt
[Méthodes disponibles sur Site Zéphyr]
o CodeUP : Code de l’Unité de Production (mnémonique ou normalisé) du dépôt.
o CodeBu : code de la Business Unit du dépôt
o Sleep : Indique si l’on souhaite les dépôts en sommeil ou non. Si le critère n’est
pas spécifié, les dépôts sont tous retournés.
o SleepDate : Date spécifiée pour les dépôts en sommeil, si le critère n’est pas
spécifié ce sera la date du jour.
Les critères sont facultatifs, si aucun critère n’est rentré on obtient l’ensemble des dépôts
(recherche paginée).
API : Zéphyr V2
Méthode : GET Récupère des dépôts Zéphyr
API : Zéphyr V1 [Obsolète depuis la V2]
Dans la V1, une méthode pour récupérer tous les dépôts et une méthode pour filtrer par critères.
Certains critères disponibles en V2 ne sont peut-être pas disponibles en V1
Méthode : GET Récupère tous les dépôts Zéphyr
Méthode : POST Récupère tous les dépôts Zéphyr filtrés par le critère de recherche fourni
5. Produits Industrie / Industry Products
- Obtenir des produits industrie Zéphyr :
Cette méthode permet :
- De récupérer la totalité des produits industrie Zéphyr ainsi que leurs attributs.
- D’obtenir grâce à un ou plusieurs critères de recherche une liste des produits industrie
Zéphyr correspondants, ainsi que leurs attributs.
Les critères que l’on peut utiliser pour la recherche sont les suivants :
o CodeUE : Code de l’Unité d’exploitation (mnémonique ou normalisé) du dossier
Zéphyr dans lequel se trouvent les produits industrie
[Méthodes disponibles sur Structures Industrie => UE Zephyr]
o Code : Code du produit de vente Zéphyr
o SegmentationNiveau4 : Code de la segmentation de niveau 4 du produit
o Sleep : Indique si l’on souhaite les produits en sommeil ou non. Si le critère n’est
pas spécifié, les produits sont tous retournés.
o SleepDate : Date spécifiée pour les dépôts en sommeil, si le critère n’est pas
spécifié ce sera la date du jour.
Les critères sont facultatifs, si aucun critère n’est rentré on obtient l’ensemble des produits
industrie (recherche paginée).
API : Zéphyr V2
Méthode : GET Récupère des produits industrie Zéphyr
API : Zéphyr V1 [Obsolète depuis la V2]
Dans la V1, une méthode pour récupérer tous les produits industrie et une méthode pour filtrer
par critères. Certains critères disponibles en V2 ne sont peut-être pas disponibles en V1
Méthode : GET Récupère tous les produits industrie Zéphyr
23
Méthode : POST Récupère tous les produits industrie Zéphyr filtrés par le critère de recherche
fourni
6. Chantiers / Jobs Zéphyr
- Obtenir l’ensemble des chantiers Zéphyr
Cette méthode permet :
- De récupérer la totalité des chantiers Zéphyr ainsi que leurs attributs.
- D’obtenir grâce à un ou plusieurs critères de recherche une liste de chantiers Zéphyr
correspondants, ainsi que leurs attributs.
Les critères que l’on peut utiliser pour la recherche sont les suivants :
o CodeUE : Code de l’Unité d’exploitation (mnémonique ou normalisé) du dossier
Zéphyr dans lequel se trouvent les chantiers souhaités.
[Méthodes disponibles sur Structures Industrie => UE Zephyr]
o Code : Code Zéphyr des chantiers souhaités
[Méthodes disponibles sur Site Zéphyr]
o Customer : Filtre sur le « Code » (Code Zéphyr du client), le « CodeUE »(Code de
l’UE de rattachement des clients) ou « IdMdm » (Identifiant MDM du client).
o Travaux : Pour les chantiers associés à un chantier Travaux, filtre possible sur le
« CodeUE » (Code de l’UE du chantier) ou sur l’« IdMdm »(Identifiant Mdm du
chantier).
o Industrie : Pour les chantiers associé à un chantier Industrie, filtres possibles sur
le « CodeBU » (Code de la Business Unit du chantier) ou sur la « SousPhase »
(Identifiant de la sous phase du chantier)
o Sleep : Indique si l’on souhaite les dépôts en sommeil ou non. Si le critère n’est
pas spécifié, les dépôts sont tous retournés.
o SleepDate : Date spécifiée pour les dépôts en sommeil, si le critère n’est pas
spécifié ce sera la date du jour.
o Adresse : Recherche sur l’adresse du chantier (Line1, Line2, ZipCode, City)
o workingDate : Si la date est renseignée, le chantier DOIT être démarré à cette
date.
Les critères sont facultatifs, si aucun critère n’est rentré on obtient l’ensemble des dépôts
(recherche paginée).
API : Zéphyr V2
Méthode : GET Récupère des chantiers Zéphyr
API : Zéphyr V1 [Obsolète depuis la V2]
Dans la V1, une méthode pour récupérer tous les produits industrie et une méthode pour filtrer
par critères. Certains critères disponibles en V2 ne sont peut-être pas disponibles en V1
Méthode : GET Récupère tous les chantiers industrie Zéphyr
Méthode : POST Récupère tous les chantiers Zéphyr filtrés par le critère de recherche fourni
- Création ou Mise à jour d’un chantier Zéphyr référencé dans le MDM pour un client
Règle : Pour une création, le client doit être COLAS.
Le Code de l’Unité d’exploitation (CodeUE), le code de l’UE de rattachement du client
(CustomerCodeUe) et l’identifiant MDM du chantier (IdMdm_Travaux) sont indispensable pour la
24
création ou la mise à jour du chantier.
Dans cette méthode il est possible de fournir l’adresse de livraison du chantier (une seule).
API : Zéphyr V2
Méthode : POST Créé ou met à jour un chantier Zéphyr référencé dans le MDM pour un client.
7. Produits de Ventes / Sales Products
- Obtenir des produits de vente Zéphyr :
Cette méthode permet :
- De récupérer la totalité des produits de vente Zéphyr ainsi que leurs attributs.
- D’obtenir grâce à un ou plusieurs critères de recherche une liste de produits de vente
Zéphyr correspondants, ainsi que leurs attributs.
Les critères que l’on peut utiliser pour la recherche sont les suivants :
o CodeUE : Code de l’Unité d’exploitation (mnémonique ou normalisé) du dossier
Zéphyr dans lequel se trouvent les produits industrie
[Méthodes disponibles sur Structures Industrie => UE Zephyr]
o Code : Code du produit de vente Zéphyr
o CodeUP : Code de l'unité de production (UPXXX) sur lequel le produit doit être
disponible à la vente (cela signifie qu’il doit être disponible et tarifé)
o CodeSite : Code du site Zéphyr sur lequel le produit doit être disponible à la vente
(cela signifie qu’il doit être disponible et tarifé)
o CodeBU : Code de la Business Unit du dépôt Zéphyr sur lequel le produit de vente
est disponible à la vente (Disponible et tarifé)
o CodeDepot : Code du dépôt Zéphyr sur lequel le produit doit être disponible à la
vente (cela signifie qu’il doit être disponible et tarifé)
o SegmentationNiveau4 : Code de la segmentation de niveau 4 du produit
o isAQP : la recherche indique si le produit de vente zéphyr est soumis à la norme
AQP ou non [Par défaut tous les produits sont recherchés]
o CodeCompositionProduct : Code du produit industrie composant les produits de
vente recherchés.
o Sleep : Indique si l’on souhaite les produits en sommeil ou non. Si le critère n’est
pas spécifié, les clients sont tous retournés.
o SleepDate : Date spécifiée pour les produits en sommeil, si le critère n’est pas
spécifié ce sera la date du jour.
Les critères sont facultatifs, si aucun critère n’est rentré on obtient l’ensemble des produits de
vente (recherche paginée).
API : Zéphyr V2
Méthode : GET Récupère des produits de vente Zéphyr
API : Zéphyr V1 [Obsolète depuis la V2]
Dans la V1, une méthode pour récupérer tous les produits de vente et une méthode pour filtrer
par critères. Certains critères disponibles en V2 ne sont peut-être pas disponibles en V1
Méthode : GET Récupère tous les produits de vente Zéphyr
Méthode : POST Récupère tous les produits de vente Zéphyr filtrés par le critère de recherche
fourni
25
8. Sites Industrie
- Obtenir des sites Zéphyr :
Cette méthode permet :
- De récupérer la totalité des sites Zéphyr ainsi que leurs attributs.
- D’obtenir grâce à un ou plusieurs critères de recherche une liste sites Zéphyr
correspondants, ainsi que leurs attributs.
Les critères que l’on peut utiliser pour la recherche sont les suivants :
o CodeUE : Code de l’Unité d’exploitation (mnémonique ou normalisé) des sites
industrie souhaités
[Méthodes disponibles sur Structures Industrie => UE Zephyr]
o CodeUP : Code de l'unité de production (UPXXX) des sites souhaités
o Sleep : Indique si l’on souhaite les sites en sommeil ou non. Si le critère n’est pas
spécifié, les clients sont tous retournés.
o SleepDate : Date spécifiée pour les sites en sommeil, si le critère n’est pas
spécifié ce sera la date du jour.
Les critères sont facultatifs, si aucun critère n’est rentré on obtient l’ensemble des sites Zéphyr
(recherche paginée).
API : Zéphyr V2
Méthode : GET Récupère des sites Zéphyr
API : Zéphyr V1 [Obsolète depuis la V2]
Dans la V1, une méthode pour récupérer tous les sites et une méthode pour filtrer par critères.
Certains critères disponibles en V2 ne sont peut-être pas disponibles en V1
Méthode : GET Récupère tous les sites Zéphyr
Méthode : POST Récupère tous les sites Zéphyr filtrés par le critère de recherche fourni
9. Magasins Industrie
- Obtenir des magasins Zéphyr :
Cette méthode permet :
- De récupérer la totalité des magasins Zéphyr ainsi que leurs attributs.
- D’obtenir grâce à un ou plusieurs critères de recherche une liste des magasins Zéphyr
correspondants, ainsi que leurs attributs.
Les critères que l’on peut utiliser pour la recherche sont les suivants :
o CodeUE : Code de l’Unité d’exploitation (mnémonique ou normalisé) des magasins
souhaités.
[Méthodes disponibles sur Structures Industrie => UE Zephyr]
o CodeStore : Code du magasin souhaité.
o CodeUP : Code de l'unité de production (UPXXX) des magasins souhaités
o CodeSite : Code du site Zéphyr des magasins souhaités
[Méthodes disponibles sur Site Industrie]
o CodeBU : Code de la Business Unit des magasins
[Méthodes disponibles sur MasterData => BU]
26
o CodeDepot : Code du dépôt Zéphyr des magasins
o Sleep : Indique si l’on souhaite les magasins en sommeil ou non. Si le critère n’est
pas spécifié, ils sont tous retournés.
o SleepDate : Date spécifiée pour les magasins en sommeil, si le critère n’est pas
spécifié ce sera la date du jour.
Les critères sont facultatifs, si aucun critère n’est rentré on obtient l’ensemble des magasins
(recherche paginée).
API : Zéphyr V2
Méthode : GET Récupère des magasins Zéphyr
10. Structures Industrie
a. Unité d’exploitation : UE Zéphyr
- Obtenir des unités d’exploitation (UE) Zéphyr
Cette méthode permet :
- De récupérer la totalité des UE Zéphyr ainsi que leurs attributs.
- D’obtenir grâce à un ou plusieurs critères de recherche une liste d’UE Zéphyr
correspondantes, ainsi que leurs attributs.
A la différence de l’API StructuresDirectory, cette méthode va permettre de n’obtenir que les UEs
utiles à l’activité Industrie.
Les critères que l’on peut utiliser pour la recherche sont les suivants :
o CodeUE : Code de l’UE souhaitée, il s’agit du code mnémonique ou libellé court
(ex : CCO44109P2)
o CodeUENormalise : Code Normalisé de l’UE souhaité (ex : UE1820)
Les critères sont facultatifs, si aucun critère n’est rentré on obtient l’ensemble des dépôts
(recherche paginée).
API : Zéphyr V2
Méthode : GET Récupère toutes les Unités d’exploitation Zéphyr
API : Zéphyr V1 [Obsolète depuis la V2]
Méthode : GET Récupère tous les Unités d’exploitation Zéphyr
11. Véhicules
a. Véhicules
- Obtenir des véhicules Zéphyr
Cette méthode permet :
- De récupérer la totalité des véhicules Zéphyr ainsi que leurs attributs.
27
- D’obtenir grâce à un ou plusieurs critères de recherche une liste de véhicules Zéphyr
correspondants, ainsi que leurs attributs.
Les critères que l’on peut utiliser pour la recherche sont les suivants :
o CodeUE : Code de l’Unité d’exploitation (mnémonique ou normalisé) du dossier
Zéphyr dans lequel se trouvent les véhicules.
[Méthodes disponibles sur Structures Industrie => UE Zephyr]
o Registration : Immatriculation des véhicules Zéphyr
o VehiculeType_Code : Code du type de véhicule Zéphyr des véhicules souhaités
[Méthodes disponibles sur Type de Véhicule / VehiculeType]
o CodeSite : Code du site Zéphyr des véhicules
[Méthodes disponibles sur Site Zéphyr]
o CodeUP : Code de l'unité de production (UPXXX) associé au site Zephyr des
véhicules souhaités
o CodeDepot : Code du dépôt Zéphyr des véhicules
[Méthodes disponibles sur Industrie => Dépôts]
o CodeBU : Code de la business Unit associée au dépôt Zéphyr des véhicules
o Driver : Code Zéphyr du chauffeur des véhicules
o Supplier_Code : Code du fournisseur Zéphyr du véhicule
o Customer_Code : Code Zéphyr du Client des véhicules
[Méthodes disponibles sur Client / Customer (Industrie)]
o Customer_CodeUE : Code de l’UE du client auquel appartiennent les céhicules
o Sleep : Indique si l’on souhaite les sites en sommeil ou non. Si le critère n’est pas
spécifié, les véhicules sont tous retournés.
o SleepDate : Date spécifiée pour les sites en sommeil, si le critère n’est pas
spécifié ce sera la date du jour.
o Registration_Tractor : immatriculation des tracteurs des véhicules
o Registration_Trailer : immatriculation des remorques des véhicules
Les critères sont facultatifs, si aucun critère n’est rentré on obtient l’ensemble des véhicules
Zéphyr (recherche paginée).
API : Zéphyr V2
Méthode : GET Récupère des sites Zéphyr
API : Zéphyr V1 [Obsolète depuis la V2]
Dans la V1, une méthode pour récupérer tous les sites et une méthode pour filtrer par critères.
Certains critères disponibles en V2 ne sont peut-être pas disponibles en V1
Méthode : GET Récupère tous les véhicules Zéphyr
Méthode : POST Récupère tous les véhicules Zéphyr filtrés par le critère de recherche fourni
b. Type de Véhicules / VehiculeType
- Obtenir l’ensemble des types de véhicules Zéphyr
Cette méthode permet :
- De récupérer la totalité des types de véhicules Zéphyr ainsi que leurs attributs.
- D’obtenir grâce à un ou plusieurs critères de recherche une liste des types de véhicules
correspondants, ainsi que leurs attributs.
Les critères que l’on peut utiliser pour la recherche sont les suivants :
28
o CodeUE : Code de l’Unité d’exploitation (mnémonique ou normalisé) du dossier
Zephyr dans lequel se trouvent les types de véhicules souhaités
[Méthodes disponibles sur Structures Industrie => UE Zephyr]
o Code : Code des types de véhicules
o Sleep : Indique si l’on souhaite les sites en sommeil ou non. Si le critère n’est pas
spécifié, les clients sont tous retournés.
o SleepDate : Date spécifiée pour les sites en sommeil, si le critère n’est pas
spécifié ce sera la date du jour.
Les critères sont facultatifs, si aucun critère n’est rentré on obtient l’ensemble des types de
véhicules Zéphyr (recherche paginée).
API : Zéphyr V2
Méthode : GET Récupère tous les types de véhicules Zéphyr
API : Zéphyr V1 [Obsolète depuis la V2]
Dans la V1, une méthode pour récupérer tous les types de véhicules, pas de méthode pour la
recherche par critères.
Méthode : GET Récupère tous les types de véhicules Zéphyr
c. Mise en attente Véhicule / PendingVehicule
- Obtenir les mises en attente de véhicules dans Zéphyr
Cette méthode permet d’obtenir grâce à un ou plusieurs critères de recherche la liste des mises
en attente de véhicules dans Zéphyr correspondants, ainsi que leurs attributs :
Les critères que l’on peut utiliser pour la recherche sont les suivants :
o CodeUE : Code de l’unité d’exploitation du dossier Zéphyr dans lequl recher les
mises en attente.
[Méthodes disponibles sur Structures Industrie => UE Zephyr]
o CodeDepot : Code du dépôt Zéphyr sur lequel les mises en attente ont été faites.
[Méthodes disponibles sur Industrie => Dépôts]
o CodeBU : Code de la business Unit associée au dépôt Zéphyr sur lequel les mises
en attente ont été faites
o CodeTransco : Code de la transcodification Zéphyr à utiliser
Le CodeUE est obligatoire pour utiliser la méthode.
API : Zéphyr V2
Méthode : GET Récupère les mises en attente de véhicule dans Zéphyr.
API : Zéphyr V1 (Obsolète avec la V2)
Méthode : POST Récupère toutes les mises en attente de véhicule dans Zéphyr filtrées par le
critère de recherche fourni
- Mettre en attente un véhicule dans Zéphyr
Création d’une mise en attente d’un véhicule.
Certains paramètres sont obligatoires :
o Le CodeUE
29
o Identification du dépôt Zéphyr soit par son CodeDepot soit par le CodeBU
(Identifiant de la Business Unit du Dépôt).
o Registration : Immatriculation du véhicule.
o Récupération du client Zéphyr à partir de son codeUE avant de le récupérer via
son code.
o Si un badge est spécifié et trouvé, ses données sont utilisées uniquement si elles
ne sont pas spécifiées dans les paramètres (les données spécifiquement
envoyées « surcharge » les données du badge).
o Le chantier est récupéré en priorité via son Id MDM, s’il est spécifié, avant son
code.
Les autres paramètres sont optionnels.
API : Zéphyr V2
Méthode : POST Met en attente un véhicule dans un dossier (UE) Zephyr
- Mettre en attente un véhicule dans Zéphyr pour une réception
Cette méthode permet de mettre en attente un véhicule pour une réception Fournisseur.
Soit la création d’une mise en attente de réception dont l’objet est passé en paramètre soit une
MAJ s’il existe une mise en attente pour les réceptions de ce véhicule.
Certains paramètres sont obligatoires :
o Le CodeUE
o Identification du dépôt Zéphyr soit par son CodeDepot soit par le CodeBU
(Identifiant de la Business Unit du Dépôt).
o Registration : Immatriculation du véhicule.
Les autres paramètres sont optionnels.
API : Zéphyr V2
Méthode : POST met en attente un véhicule dans un dossier (UE) Zéphyr pour une réception
- Supprimer une mise en attente d’un véhicule dans Zéphyr
Cette méthode permet de supprimer un véhicule des mises en attente d’un dossier Zéphyr.
La suppression se fait à partir des paramètres suivants :
o CodeUe : Identifiant de l’UE (code mnémonique ou normalisé) du dossier Zéphyr
dans lequel supprimer la mise en attente.
o Registration : Immatriculation du véhicule à supprimer des mises en attente
o CodeTransco : Code de la transcodification à utiliser dans Zéphyr.
Les paramètres CodeUe et Registration sont obligatoires.
API : Zéphyr V2
Méthode : DELETE Supprime un véhicule des mises en attente d’un dossier (UE) Zéphyr
12. Commandes Techniques Zéphyr (Obsolète avec la V2)
Depuis la V2 les commandes Zéphyr se trouve directement avec la ressource concernée.
Les méthodes sous Commandes Zéphyr (ZephyrCommand) permettent de transmettre des
informations à Zéphyr dans la V1 de l’API.
- Créer un appel de livraison dans Zephyr
30
API : Zéphyr V1 (Obsolète avec la V2)
Méthode : POST Création d’un appel de livraison dans Zéphyr
- Importer un bon de livraison dans Zephyr
API : Zéphyr V1 (Obsolète avec la V2)
Méthode : POST Import d’un bon de livraison dans Zephyr
- Mettre en attente un véhicule dans Zéphyr
API : Zéphyr V1 (Obsolète avec la V2)
Méthode : POST Met en attente un véhicule dans Zephyr
- Mettre en attente un véhicule pour les achats dans Zéphyr
Cette méthode permet de mettre en attente un véhicule venant pour une Commande provenant
de COUPA.
API : Zéphyr V1 (Obsolète avec la V2)
Méthode : POST met en attente un véhicule pour les achats dans Zéphyr
- Supprimer une mise en attente d’un véhicule dans Zéphyr
API : Zéphyr V1 (Obsolète avec la V2)
Méthode : POST Supprime une mise en attente d’un véhicule dans Zéphyr
- Vérifier l’existence d’un bon de livraison pour un véhicule donné.
API Zéphyr V1 (Obsolète avec la V2)
Méthode ; POST Vérifie l’existence d’un bon de livraison pour un véhicule donné dans Zéphyr
31
Domaine : Achats
APIs Version Domaine Balises
Coupa Console V1 Achats Fournisseurs
Coupa PO V1 Achats PO (Bon de commande)
1. Fournisseurs
Si le besoin est de récupérer l’ensemble des fournisseurs, il est préférable de gérer cela avec le
MDM Fournisseur qui est l’application référentielle de cette ressource (par Flux ou API => voir
MasterData).
- Obtenir les informations achats d’un fournisseur
Cette méthode permet de récupérer les informations d’achats d’un fournisseur. Cela permet
d’obtenir la carte de visite de celui-ci (Contact, téléphone, …) mais aussi des informations achats
comme les méthodes d’envoi de bons de commande et la liste des Contents groups du
fournisseur.
Paramètre d’entrée Obligatoire :
o Id : Identifiant MDM Du fournisseur souhaité
API : Coupa Console E4 V1
Méthode : GET Récupère un fournisseur via son identifiant MDM
- Créer un Fournisseur ou MAJ des informations achats d’un Fournisseur :
Cette méthode permet de créer un fournisseur dans la console Coupa ou de mettre à jour ses
informations d’achats.
Les informations à fournir sont décrites dans le corps de la demande sur l’APIM.
Règle : Si l’on choisit l’envoi automatique au Fournisseur, il est obligatoire de fournir l’email.
L’API est utilisée par le MDM, référentiel des Fournisseurs et légitime à ajouter ou modifier des
informations de ce type.
API : Coupa Console E4 V1
Méthode : POST Demande une mise à jour ou création d’un fournisseur dans la console Coupa
2. Bon de Commande (Purchase Order)
- Obtenir les bons de commandes d’un chantier:
Cette méthode permet d’obtenir les bons de commandes d’un chantier présents dans Coupa via
la Base Miroir.
La réponse retournée est similaire au pivot PurchaseOrder.
La recherche se fait par l’ID MDM du chantier.
API : Coupa PO V1
Méthode : GET PO360
32
Domaine : Finance
APIs Version Domaine Balises
Invoice V1 Finance Factures/IBAN
V1
1. Factures
- Obtenir une facture par son numéro
Cette méthode permet de récupérer une facture par son numéro.
Paramètre d’entrée Obligatoire :
o numFacture : numéro de la facture souhaitée
API : Invoice APIs E4 V1
Méthode : GET Facture by its number
2. IBAN
Ces méthodes sont utilisées lors des paiements dématérialisés pour la vérification et le contrôle
des IBAN.
- Obtenir l’ensemble des IBAN:
Cette méthode permet d’obtenir les IBAN à partir d’une certaine date.
Paramètre de recherche possible :
o FromDate : Date à partir de laquelle vous souhaitez rechercher les IBAN.
API: Invoice APIs E4 V1
Méthode: GET all IBANs from date
- Obtenir les IBAN des factures KO:
Cette méthode permet d’obtenir les IBAN des factures KO.
Paramètre de recherche possible :
o FromDate : Date à partir de laquelle vous souhaitez rechercher les IBAN.
API: Invoice APIs E4 V1
Méthode: GET IBAN from invoice KO.
- Obtenir les IBAN à vérifier avant de procéder au paiement:
Cette méthode permet d’obtenir les IBAN à vérifier avant de procéder au paiement.
Paramètre de recherche possible :
o FromDate : Date à partir de laquelle vous souhaitez rechercher les IBAN.
API: Invoice APIs E4 V1
Méthode: GET IBAN to check before process payment.
33
Domaine : RH
APIs Version Domaine Balises
HRA V1 RH Collaborateur, Photo
SelfHRA V1 RH
Les APIs du domaine RH exposent et manipulent des données qui sont soumises à la RGPD et à
des besoins de sécurité. Même en interne l’utilisation de certaines données doit être contrôlée et
sécurisée.
3. Collaborateurs
- Obtenir la liste des collaborateurs :
Cette méthode permet de récupérer l’ensemble des collaborateurs sans leurs photos.
Dans le retour on obtiendra plusieurs informations sur le collaborateur (nom, prénom, statut,
fonction, société, solde, restAPrendre, Self, rôle, pays).
API : HRA V1
Méthode : GET Collaborateurs
Pour obtenir les informations d’un seul collaborateur le login est utilisé en paramètre d’entrée.
- Obtenir les photos des collaborateurs.
Cette méthode permet de récupérer les phots des collaborateurs.
Dans le retour on obtient le login de l’utilisateur à qui appartient la photo et le nom de la photo
notamment.
API : HRA V1
Méthode : GET Photos
4. Informations Collaborateurs
- Diplômes d’un collaborateur :
API : SelfHra V1 Mots clés : degree/degrees
Ces méthodes permettent d’obtenir la liste des diplômes mais aussi de modifier ou d’ajouter des
diplômes. Afin de pouvoir faire cela, on expose des APIs permettant de récupérer les différents
codes liés aux diplômes (types, statuts, niveaux, …)
- Adresses d’un collaborateur :
API : SelfHra V1 Mots clés : address
Ces méthodes permettent d’obtenir la liste des adresses et des données téléphoniques d’un
collaborateur mais aussi de modifier ou d’ajouter des informations. Afin de pouvoir faire cela, on
expose des APIs permettant de récupérer les différents codes liés à ces données (types, …)
- Formation :
API : SelfHra V1 Mots clés : training /courses
34
Ces méthodes permettent :
o La recherche des formations et des stages
o D’obtenir les formations d’un employé spécifique ou de l’ensemble des employés
d’un manager spécifique
o D’obtenir l’historique des formations
o De faire une demande de formation ou de stage (à l’aide d’APIs permettant de
récupérer les différents codes permettant d’identifier les formations).
- Taches :
API : SelfHra V1 Mots clés : Task
Ces méthodes permettent :
o D’obtenir la liste des tâches (possibilité de lister par catégories)
o D’obtenir l’ensemble des tâches archivés ou les tâches archivées pour certaines
catégories (absence, formation, stage).
o Supprimer des tâches archivées
o D’ouvrir certains types de tâches demandant validation (Profil Manager) :
Absence, congés, document officiels, stages, formations ou des modifications
d’informations (informations bancaires, statut marital, diplômes, adresses,
téléphone).
o De valider des tâches (Profil Manager)
- Délégations :
API : SelfHra V1 Mots clés : Delegation
Ces méthodes permettent :
o D’obtenir la liste des rôles de délégations.
o Rechercher des users pour délégation.
o Créer, modifier, supprimer une délégation de rôle.
- Demandes/Requests :
API : SelfHra V1 Mots clés : Request
Ces méthodes permettent :
o D’obtenir la liste des demandes d’un employée (possibilité de lister par
catégories)
o D’obtenir la liste des demandes annulables.
o D’ouvrir une demande (par l’identifiant de la request) pour différentes catégories
de demandes : Absence, Formation, Documents officiels, changement de
situation (Banque, adresse, … ), diplômes, etc.
[1 méthode différente pour chaque type de ressource]
o De soumettre une demande pour différentes catégories : Absence, modification
de contacts, de statuts ou de documents officiels.
o D’annuler ou de supprimer des demandes.
o De valider ou de refuser des demandes (Profil Manager)
[En cours]
35
Domaine : Réglementaires/MLV (Master List Of Values)
APIs Version Domaine Balises
MasterLOV V1 MLV Réglementaires
Les réglementaires sont des listes de codes de taille limitée et qui évolue peu dans le temps.
Ils peuvent être regroupés en trois familles :
- Réglementaire localisé : un identifiant, un libellé par défaut et une liste de libellés par
culture. Il est possible d’ajouter des champs supplémentaires comme le code pays ou un
code ERT.
- Réglementaire localisé avec des libellés courts : en plus du précédent, on a un libellé
court par défaut et pour chaque culture, on a également un libellé court.
- Réglementaire non localisé : un identifiant et une liste de champs libres.
1. Listes des Réglementaires diffusés via API
Pour chaque réglementaire il existe deux méthodes. L’une permet de récupéré l’ensemble du
réglementaire (GetAll), l’autre permet de récupérer un élément du réglementaire par son ID
(GetById).
Réglementaire Label ENG Méthodes
Activités Activites GET Activites_GetAll GET Activites_GetById
Activités Niv1 ActivitiesLevel1 GET ActivitiesLevel1_GetAll GET ActivitiesLevel1_GetById
Activités Niv2 ActivitiesLevel2 GET ActivitiesLevel2_GetAll GET ActivitiesLevel2_GetById
Activités Niv3 ActivitiesLevel3 GET ActivitiesLevel3_GetAll GET ActivitiesLevel3_GetById
Phase BuPhases GET BuPhases_GetAll GET BuPhases_GetById
SousPhases BU BuSubPhases GET BuSubPhases_GetAll GET BuSubPhases_GetById
Motif de rectification ChangeRequestCauses GET ChangeRequestCauses_GetAll GET ChangeRequestCauses_GetById
Type de marché ContractTypes GET ContractTypes_GetAll GET ContractTypes_GetById
Montage Contractuel ContractualSetups GET ContractualSetUps_GetAll GET ContractualSetUps_GetById
Comté Counties GET Counties_GetAll GET Counties_GetById
Pays Countries GET Countries_GetAll GET Countries_GetById
36
Devises Currencies GET Currencies_GetAll GET Currencies_GetById
Activité du client CustomerActivities GET CustomerActivities_GetAll GET CustomerActivities_GetById
Statut marché CustomerContractStatuses GET CustomerContractStatuses_GetAll GET CustomerContractStatuses_GetById
Nature de Client CustomerNatures GET CustomerNatures_GetAll GET CustomerNatures_GetById
Statut du Client CustomerStatuses GET CustomerStatuses_GetAll GET CustomerStatuses_GetById
Fonction du personnel EmployeeFunctions GET EmployeeFunctions_GetAll GET EmployeeFunctions_GetById
Catégorie de dépense ExpenseCategories GET ExpenseCategories_GetAll GET ExpenseCategories_GetById
Statut des phases de chantier JobPhaseStatuses GET JobPhaseStatuses_GetAll GET JobPhaseStatuses_GetById
Statut de chantier JobStatuses GET JobStatuses_GetAll GET JobStatuses_GetById
Langues Languages GET Languages_GetAll GET Languages_GetById
Portée MasterDataScopes GET MasterDataScopes_GetAll GET MasterDataScopes_GetById
Motif de non-conformité NonComplianceCauses GET NonComplianceCauses_GetAll GET NonComplianceCauses_GetById
Mode de paiement PaymentMethods GET PaymentMethods_GetAll GET PaymentMethods_GetById
Délai de règlement PaymentPeriods GET PaymentPeriods_GetAll GET PaymentPeriods_GetById
Type de Produit ProductTypes GET ProductTypes_GetAll GET ProductTypes_GetById
Statut affaire ProjectStatuses GET ProjectStatuses_GetAll GET ProjectStatuses_GetById
Nature de bon de commande PurchaseOrderNatures GET PurchaseOrderNatures_GetAll GET PurchaseOrderNatures_GetById
Statut bon de commande PurchaseOrderStatuses GET PurchaseOrderStatuses_GetAll GET PurchaseOrderStatuses_GetById
Sécurisations Securizations GET Securizations_GetAll GET Securizations_GetById
Segmentation Niv1 SegmentationsLevel1 GET SegmentationsLevel1_GetAll GET SegmentationsLevel1_GetById
Segmentation Niv2 SegmentationsLevel2 GET SegmentationsLevel2_GetAll GET SegmentationsLevel2_GetById
Segmentation Niv3 SegmentationsLevel3 GET SegmentationsLevel3_GetAll GET SegmentationsLevel3_GetById
Segmentation Niv4 SegmentationsLevel4 GET SegmentationsLevel4_GetAll GET SegmentationsLevel4_GetById
37
Catégorie de coût standard StandardCostCategories GET StandardCostCategories_GetAll GET StandardCostCategories_GetById
Province/Etats States GET States_GetAll GET States_GetById
Nature de Fournisseur SupplierNatures GET SupplierNatures_GetAll GET SupplierNatures_GetById
Type de Fournisseur SupplierTypes GET SupplierTypes_GetAll GET SupplierTypes_GetById
Catégorie de Tiers ThirdPartyCategories GET ThirdPartyCategories_GetAll GET ThirdPartyCategories_GetById
Motif d'indisponibilité UnavailabilityCauses GET UnavailabilityCauses_GetAll GET UnavailabilityCauses_GetById
Unité (d'œuvre) UnitOfWorks GET UnitOfWorks_GetAll GET UnitOfWorks_GetById
Profil Utilisateur UserProfiles GET UserProfiles_GetAll GET UserProfiles_GetById
Régime de TVA VatRegimes GET VatRegimes_GetAll GET VatRegimes_GetById
Domaine : APIs de Service
APIs Version Domaine Balises
CANT V1 Services Notifications
Colflux Publix V1 Services Statut Flux, Parc Colflux
DocTec V1 Services Référentiel DocTec
EContract V1 Services Bases EContract
MFA V1 Services Authentification Forte
1. CANT Cette API permet de récupérer un ensemble de notifications provenant d’applications diverses
afin de les afficher en notification sur le portail MyColas.
- Obtenir les applications générant des notifications
Cette méthode permet de récupérer la liste des applications qui génère des notifications
nécessaires à l’utilisateur.
API : Cant V1
Méthode : GET Returns the list of all applications generating notifications
- Obtenir les notifications d’un utilisateur
Cette méthode permet de récupérer l’ensemble des notifications d’un utilisateur.
Paramètres d’entrée :
o userLogin (obligatoire) : login de l’utilisateur dont on veut récupérer les
notifications
38
o allNotifiactions (facultatif) : permet de récupérer aussi les notifications
désactivées et non qualifiées si besoin.
API : Cant V1
Méthode : GET Returns the notifications of a specific user
- Changer le statut d’une notification
Cette méthode permet de changer le statut d’une notification afin de passer son statut à « Lu »
Paramètres d’entrée obligatoires:
o userLogin (obligatoire) : login de l’utilisateur dont on veut modifier la notification
o notifid : identifiant de la notifiaction à marquer comme lu.
API : Cant V1
Méthode : GET Returns the list of all applications generating notifications
2. ColfluxPublic
a. Flux
- Obtenir le Statut des Flux par SJ :
Cette méthode permet de récupérer l’état d’ouverture de l’ensemble des flux par SJ. Dans Colflux,
un flux peut avoir 3 statuts:
- “Store & Broadcast”: Stocké dans WLREF et diffusé aux applications.
- « Store » : Stocké dans WLREF
- « Ignore » : le flux est fermé.
La recherche peut être filtrée par le nom du flux ou la SJ.
API: Colflux Public API V1
Méthode: GET Returns the broadcast state of the flows by SJ.
b. Parc Colflux
Ces méthodes permettent d’avoir une vision du parc applicatif Colflux.
- Obtenir les informations d’un ou de l’ensemble des serveurs :
API: Colflux Public API V1
Méthode: GET Returns the list of all servers.
GET Returns one server mentioned by its name.
- Obtenir les informations des Sites Informatiques :
API: Colflux Public API V1
Méthode: GET Returns the list of all sites.
GET Returns one site mentioned by its name.
- Obtenir les informations du parc d’application Colflux :
39
Cette méthode permet d’avoir une vision du parc d’application Colflux. Pour chaque application il
est indiqué son serveur, son site informatique ainsi que sur quelle UE elle est déployée.
Il est possible de filtrer la recherche sur l’ensemble de ces critères.
API: Colflux Public API V1
Méthode: GET Returns the list of all applications
- Obtenir les informations de routage des Applications :
API: Colflux Public API V1
Méthode: GET Returns all the routings of applications.
c. Structures
- Obtenir la version IRIS de l’une ou l’ensemble des SJ :
Cette méthode permet de récupérer la version IRIS des différentes SJ. Si la SJ est passée en IRIS
3 on obtient aussi sa date de bascule.
API: Colflux Public API V1
Méthode: GET Returns the list of all SJs with the Iris version of each
GET Returns one SJ mentioned by its identifier, with its Iris version
3. DocTec
Cette API permet de consulter le référentiel des DocTec. Une DocTec est un espace de partage au
niveau UE qui est monté sur différents sites informatiques.
Cette API est notamment utilisée par Chantier360 afficher le dossier de partage pour un chantier
via son UE.
- Obtenir les chemins DocTech d’un site informatique spécifique :
Cette méthode permet de récupérer l’ensemble des chemins DocTec associés à leurs UE et
l’instance E-Contract qui les manage pour un site informatique spécifique.
API: DocTec V1
Méthode: GET Dedicated to EContract: Returns all the DocTec mappings associated with the UEs
managed by a specific EContract instance, specified by its IT site name
- Obtenir les chemins DocTech d’un site informatique spécifique :
Cette méthode permet de récupérer l’ensemble des chemins DocTec associés à leurs UE et
l’instance E-Contract qui les manage. Cette méthode laisse la possibilité de filtrer selon plusieurs
critères (Site Informatique, UE, … ).
API: DocTec V1
Méthode: Get Returns all the DocTec mappings matching the multi-criteria search.
4. E-Contract
- Obtenir l’ensemble des bases E-Contract et leurs informations techniques :
Cette méthode est notamment utilisée par la BI pour connaitre les noms des serveurs et des
bases E-Contract afin de pouvoir y accéder.
40
Il existe une méthode pour obtenir l’ensemble des bases et une seconde permettant de cibler les
bases d’un site informatique spécifique.
API: EContract E4 V1
Méthode: GET ECDatabases_GetAll
GET ECDatabases_GetBySiteName
5. MFA Authentification
WIP