SIGMA-RH

Zoomer en arrière
Texte plus grand | Texte plus petit
Masquer l'en-tête de page
Afficher texte extensible
Version imprimable
Envoyer cette rubrique par courrier électronique
Enregistrer URL Permalien

Navigation: Administration de l'application > Configurer les services Web > Services Web (REST)

Service Web d'import (REST)

Déroulement Précédent Page d'accueil Suivant Plus

Le service Web d'import (REST) permet d'importer des données dans SIGMA-RH à l'aide des méthodes suivantes :

•Méthode POST createbatch

•Méthode POST addsection

•Méthode POST addrecord

•Méthode POST commit

•Méthode POST getstatus

Ce service s'appuie sur l'import standard pour son fonctionnement interne. Les sections, paramètres et format de données sont donc les mêmes que ce qui est documenté dans la section import standard de l'aide en ligne de SIGMA-RH. Il est recommandé de bien comprendre le fonctionnement des imports standards dans SIGMA-RH avant de se lancer dans le développement d'import par service Web.

Astuce

Note : Vous pouvez consulter dans SIGMA-RH le journal d'exécution du service Web pour les lots d'import.

Méthode POST createbatch

Cette méthode vous permet de créer un lot d'import. La création du lot retournera un numéro d'identification qui sera utilisé dans l'appel des autres méthodes.

Adresse Web (endpoint)

https://www.sigma-rh.net/<client>/webservices/restdataimport.svc/createbatch

Body : en format JSON

1 {

2 "authenticationToken": [176,26,...],

3 "parameters": [{"Key":"param1", "Value":"value1"},

4 {"Key":"param2", "Value":"value2"}],

5 "autoCommit": "true"

Définition

Paramètre

Description

authenticationToken

Tableau d'octets représentant le jeton d'authentification.

parameters

Liste des paramètres d'import. Dans le dictionnaire, les clés sont les noms de paramètres et les valeurs la valeur du paramètre. Tout en string.

autoCommit

True si on veut que l'import démarre tout seul en cas de timeout (délai d'attente dépassé depuis la dernière action sur un lot d'import.)

Exemple

Post: https://www.sigma-rh.net/<client>/webservices/restdataimport.svc/createbatch

Content-type: application/json

2 "authenticationToken": [176,26,32,43,55,66,23,8,32],

3 "parameters": [{"Key":"Version", "Value":"1"},

4 {"Key":"separateurDeChamp", "Value":"|"}],

5 "autoCommit": "true"

Réponse

Explications

HTTP Status 200 OK

La réponse inclut l'identifiant du lot d'import créé. Cet identifiant sert à interroger le statut ou encore alimenter son contenu.

HTTP Status 400 Bad Request

Jeton d'identification absent ou paramètre invalide

2 "argument": "Bad request.",

3 "message": null,

4 "ExceptionType": "System.InvalidOperationException"

HTTP Status 401 Unauthorized

Le jeton d'authentification est invalide.

2 "Message": "Authentication failed.",

3 "StackTrace": null,

4 "ExceptionType": "System.InvalidOperationException"

Méthode POST addsection

Cette méthode permet d'ajouter une section au lot d'import.

Adresse Web (endpoint)

https://www.sigma-rh.net/<client>/webservices/restdataimport.svc/addsection

Body : en format JSON

1 {

2 "authenticationToken": [176,26,...],

3 "batchIdentifier": "5169374b-b98f-41cb-bb4b-84df05e91c2d",

4 "sectionIdentifier": "sectionName",

5 "parameters": [{"Key":"param1", "Value":"value1"},

6 {"Key":"param2", "Value":"value2"}]

7 }

Définition

Paramètre

Description

authenticationToken

Tableau d'octets représentant le jeton d'authentification.

batchIdentifier

Identifiant du lot.

sectionIdentifier

Nom de la section d'import.

parameters

Liste de paramètre de la section d'import. Dans le dictionnaire, les clés sont les noms de paramètres et les valeurs la valeur du paramètre. Tout en string

Exemple

1 Post: https://www.sigma-rh.net/<client>/webservices/restdataimport.svc/addsection

3 Content-type: application/json

6 "authenticationToken": [176,26,32,43,55,66,23,8,32],

7 "batchIdentifier": "5169374b-b98f-41cb-bb4b-84df05e91c2d",

8 "sectionIdentifier": "Vaccination",

9 "parameters": [{"Key":"ClefVaccination", "Value":"Chutil_20"}],

10}

Réponse

Explications

HTTP Status 200 OK

La requête est valide.

HTTP Status 400 Bad Request: argument Invalid

Cette réponse s'affiche quand la section existe déjà dans le lot d'import ou que le lot n'existe pas.

2 "argument": "batchIdentifier”

3 "message": "The specified batch doesn't exists in the system"

HTTP Status 401 Unauthorized

Le jeton d'authentification est invalide.

2 "Message": "Authentication failed.",

3 "StackTrace": null,

4 "ExceptionType": "System.InvalidOperationException"

HTTP Status 406 Not Acceptable

L'opération demandée ne peut pas être effectuée.

2 "argument": "batchIdentifier”

3 "message": "The requested operation cannot be performed on a batch with a 'Imported' status.",

4 "code": "3"

Liste des codes d'erreurs accompagnant le 406

Code d'erreur

Explications

Le lot indiqué n'existe pas.

L'accès est refusé au lot spécifié, avec les informations d'authentification fournies.

L'action demandée ne peut être effectuée sur le lot spécifié, en raison du statut du lot.

Méthode POST addrecord

Cette méthode permet d'ajouter des éléments à importer dans une section. Il est important que tous les éléments de la même section aient les mêmes champs définis.

Adresse Web (endpoint)

https://www.sigma-rh.net/<client>/webservices/restdataimport.svc/addrecord

Body : en format JSON

2 "authenticationToken": [176,26,...],

3 "batchIdentifier": "5169374b-b98f-41cb-bb4b-84df05e91c2d",

4 "sectionIdentifier": "sectionName",

5 "values": [{"Key":"c1", "Value":"v1"},

6 {"Key":"c2", "Value":"v2"}]

Définition

Paramètre

Description

authenticationToken

Tableau d'octets représentant le jeton d'authentification.

batchIdentifier

Identifiant du lot.

sectionIdentifier

Nom de la section d'import.

values

Liste des valeurs à importer pour un item. Dans le dictionnaire, les clés sont les noms de champs et les valeurs la valeur du champ. Tout en string.

Exemple

1 Post: https://www.sigma-rh.net/<client>/webservices/restdataimport.svc/addrecord

3Content-type: application/json

6 "authenticationToken": [176,26,32,43,55,66,23,8,32],

7 "batchIdentifier": "5169374b-b98f-41cb-bb4b-84df05e91c2d",

8 "sectionIdentifier": "Vaccination",

9 "values": [{"Key": "ClefVaccination", "Value":"0000000001"},

10 {"Key":"NoEntLeg", "Value":"001"},

11 {"Key":"NoDivision", "Value":"001"},

12 {"Key":"NoSecEco", "Value":"001"},

13 {"Key":"NoEtabli", "Value":"001"},

14 {"Key":"NoMatricule", "Value":"000001"},

15 {"Key":"DateEven":, "Value":"20220101"},

16 {"Key":"ReferentielVaccin":, "Value":"000000001"},

17 {"Key":"NoVaccin", "Value":"000001"}]

18}

Réponse

Explications

HTTP Status 200 OK

La réponse inclut l'identifiant de l'élément ajouté. Elle sert à retracer l'élément ajouté dans le journal d'erreur.

HTTP Status 400 Bad Request: argument Invalid

Cette réponse s'affiche quand le lot n'existe pas.

2 "argument": "batchIdentifier”

3 "message": "The specified batch doesn't exists in the system"

HTTP Status 401 Unauthorized

Le jeton d'authentification est invalide.

2 "Message": "Authentication failed.",

3 "StackTrace": null,

4 "ExceptionType": "System.InvalidOperationException"

HTTP Status 406 Not Acceptable

L'opération demandée ne peut pas être effectuée.

2 "argument": "batchIdentifier”

3 "message": "The requested operation cannot be performed on a batch with a 'Imported' status.",

4 "code": "3"

Liste des codes d'erreurs accompagnant le 406

Code d'erreur

Explications

Le lot indiqué n'existe pas.

L'accès est refusé au lot spécifié, avec les informations d'authentification fournies.

L'action demandée ne peut être effectuée sur le lot spécifié, en raison du statut du lot.

Méthode POST commit

Après avoir transmis toute l'information nécessaire, cette méthode exécute l'import des données dans le système.

Adresse Web (endpoint)

https://www.sigma-rh.net/<client>/webservices/restdataimport.svc/commit

Body : en format JSON

2 "authenticationToken": [176,26,...],

3 "batchIdentifier": "5169374b-b98f-41cb-bb4b-84df05e91c2d"

Définition

Paramètre

Description

authenticationToken

Tableau d'octets représentant le jeton d'authentification.

batchIdentifier

Identifiant du lot.

Exemple

1 Post: https://www.sigma-rh.net/<client>/webservices/restdataimport.svc/Commit

3 Content-type: application/json

6 "authenticationToken": [176,26,32,43,55,66,23,8,32],

7 "batchIdentifier": "5169374b-b98f-41cb-bb4b-84df05e91c2d"

Réponse

Explications

HTTP Status 200 OK

La requête est valide.

HTTP Status 400 Bad Request: argument Invalid

Le lot n'a pas été identifié.

2 "argument": "batchIdentifier”

3 "message": "A batch identifier is required."

HTTP Status 401 Unauthorized

Le jeton d'authentification est invalide.

2 "Message": "Authentication failed.",

3 "StackTrace": null,

4 "ExceptionType": "System.InvalidOperationException"

HTTP Status 406 Not Acceptable

L'opération demandée ne peut pas être effectuée.

2 "argument": "batchIdentifier”

3 "message": "The requested operation cannot be performed on a batch with a 'Imported' status.",

4 "code": "3"

Liste des codes d'erreurs accompagnant le 406

Code d'erreur

Explications

Le lot indiqué n'existe pas.

L'accès est refusé au lot spécifié, avec les informations d'authentification fournies.

L'action demandée ne peut être effectuée sur le lot spécifié, en raison du statut du lot.

Méthode POST getstatus

Cette méthode permet de récupérer le statut d'un lot d'import.

Adresse Web (endpoint)

https://www.sigma-rh.net/<client>/webservices/restdataimport.svc/getstatus

Body : en format JSON

2 "authenticationToken": [176,26,...],

3 "batchIdentifier": "5169374b-b98f-41cb-bb4b-84df05e91c2d"

Définition

Paramètre

Description

authenticationToken

Tableau d'octets représentant le jeton d'authentification.

batchIdentifier

Identifiant du lot.

Exemple

1 Post: https://www.sigma-rh.net/<client>/webservices/restdataimport.svc/Commit

3 Content-type: application/json

6 "authenticationToken": [176,26,32,43,55,66,23,8,32],

7 "batchIdentifier": "5169374b-b98f-41cb-bb4b-84df05e91c2d"

Réponse

Explications

HTTP Status 200 OK

Objet du statut du lot.

Informations figurant dans les sections retournées

Section

Explications

errorMessage

Contient le résumé de l'import. On y précise le nombre de lignes lues, importées, avec erreur et avec avertissement.

importMessages

Si cette section est vide, c'est qu'il n'y a aucun message d'erreur. S'il y a des erreurs à la suite de la méthode commit, vous verrez des informations supplémentaires.

Informations supplémentaires

Explications

description

Comprend les détails du message.

details

Contient la liste des erreurs de la ligne traitée.

•context : Contexte de l'erreur. Dans le cas d'import, contient le nom de la colonne de la table de données.

•description : Description de l'erreur.

error

Identifie si la ligne est en erreur ou pas.

▪true : aucune erreur présente

▪false : erreur présente

message

Donne l'état de la ligne dans l'import.

recordIdentifier

Identifiant de l'élément en erreur. Corresponds à la valeur retournée par la méthode addrecord.

status

Statut du lot.

•1. Pending : le lot a été créé et est en attente pour recevoir son contenu et être enregistré.

•2. Expired : le lot a expiré après le timeout d'inactivité.

•3. Committed : la méthode commit du lot a été effectuée et le lot est en cours de traitement.

•4. Imported : l'import du lot s'est terminé sans avertissements et sans erreurs.

•5. ImportedWithWarnings : l'import du lot s'est terminé avec des avertissements, mais sans erreurs.

•6. ImportedWithErrors : l'import du lot s'est terminé avec des erreurs (possibilité d'avoir également des avertissements).

HTTP Status 400 Bad Request: argument Invalid

Le lot n'a pas été identifié.

2 "argument": "batchIdentifier”

3 "message": "A batch identifier is required."

HTTP Status 401 Unauthorized

Le jeton d'authentification est invalide.

2 "Message": "Authentication failed.",

3 "StackTrace": null,

4 "ExceptionType": "System.InvalidOperationException"

Voir aussi...

Service Web d'authentification (REST)

Services Web de requête (REST)

Sommaire
Index
Recherche

Veuillez actier les JavaScript pour afficher ce site.

SIGMA-RH

Adresse Web (endpoint)

Body : en format JSON

Définition

Exemple

Réponse

Adresse Web (endpoint)

Body : en format JSON

Définition

Exemple

Réponse

Adresse Web (endpoint)

Body : en format JSON

Définition

Exemple

Réponse

Adresse Web (endpoint)

Body : en format JSON

Définition

Exemple

Réponse

Adresse Web (endpoint)

Body : en format JSON

Définition

Exemple

Réponse

Informations figurant dans les sections retournées