API REST RH
L’API REST RH fournit des points de terminaison qui renvoient des informations sur les employés qui travaillent ou vivent aux États-Unis.
Pour accéder à cette API, vous devez avoir le rôle sn_hr_core.usa_employee_only et le module d’extension Human Resources Scoped App : Core (com_sn_hr_core) activé.
REST RH : OBTENIR /get_usa_employee_profile
Renvoie les informations de profil de l’employé pour les employés basés aux États-Unis.
- Informations de profil de l’employé pour un ID d’employé spécifié.
- Informations relatives aux employés qui ont été ajoutés ou dont les informations ont été mises à jour à une date spécifiée ou après cette date.
- Identificateur d’employé
- Prénom
- Deuxième prénom
- Nom de famille
- Adresse de travail
- WorkCity
- État de travail
- Code postal du travail
- WorkCountry
- Adresse du domicile
- Ville d’origine
- État d’accueil
- AccueilCode postal
- Pays d’origine
- Date de naissance
- Date d’embauche
Format d'URL
URL par défaut : /api/sn_hr_core/hr_rest_api/get_usa_employee_profile
Paramètres de demande pris en charge
| Nom | Description |
|---|---|
| Néant |
| Paramètre | Description |
|---|---|
| employee_identifier | Identificateur unique d’un employé. Le système d’appel génère cette valeur et peut être dans n’importe quel format compatible avec son système. Pour obtenir cette valeur, appelez d’abord le point de terminaison à l’aide du updated_after paramètre. Remarque : Ce paramètre s’exclut mutuellement avec le updated_after paramètre. Ce paramètre définit un employé unique, tandis que updated_after renvoie un groupe d’employés créés/mis à jour après une date spécifiée. Type de données : chaîne |
| sysparm_limit | Nombre maximal d’enregistrements à renvoyer. Pour les demandes qui dépassent ce nombre d’enregistrements, utilisez le paramètre pour paginer la récupération de l’enregistrement sysparm_offset . Type de données : nombre Valeur par défaut : 1 000 |
| sysparm_offset | Démarrage de l’index d’enregistrement pour lequel commencer à récupérer des enregistrements. Utilisez cette valeur pour paginer la récupération de l’enregistrement. Cette fonctionnalité permet de récupérer tous les enregistrements, quel que soit leur nombre, en petits blocs gérables.
Par exemple, la première fois que vous appelez ce point sysparm_offset de terminaison est défini sur « 0 ». Pour parcourir simplement tous les enregistrements disponibles, utilisez |
| updated_after | Date à utiliser pour déterminer les données de l’employé à renvoyer. Tous les employés basés aux États-Unis (professionnels ou à domicile) qui ont été ajoutés à votre instance ou dont les informations ont été mises à jour à la date indiquée ou après cette date sont inclus dans les résultats de retour. Remarque : Ce paramètre s’exclut mutuellement avec le employee_identifier paramètre. Type de données : chaîne Format : AAAA-MM-JJ HH :MM :SS ou AAAA-MM-JJ (l’heure par défaut est 00:00:00) |
| Nom | Description |
|---|---|
| Néant |
En-têtes
Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP ou s’appliquent à cette action d’une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.
| En-tête | Description |
|---|---|
| Accepter | Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json |
| En-tête | Description |
|---|---|
| Page suivante | Marqueur indiquant s’il existe des données supplémentaires à obtenir lors d’un appel ultérieur. Par exemple, si un total de 120 enregistrements d’employés correspondent aux critères de recherche et que sysparm_limit est défini sur 100, alors Next-Page la valeur est vrai. Si aucun résultat supplémentaire n’est disponible, Next-Page est faux. Valeurs valides :
|
Codes d'état
Les codes d’état suivants s’appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.
| Code d'état | Description |
|---|---|
| 200 | Réussi. La demande a été traitée avec succès. |
| 401 | Non autorisé. Les informations d’identification de l’utilisateur sont incorrectes ou n’ont pas été transmises. |
| 404 | Introuvable. L’élément demandé est introuvable. |
| 500 | Erreur interne du serveur. Une erreur inattendue s’est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l’erreur. |
Paramètres du corps de la réponse (JSON ou XML)
| Élément | Description |
|---|---|
| Date de naissance | Date de naissance de l’employé. Type de données : chaîne |
| Société | Nom de la société. Type de données : chaîne |
| Adresse e-mail de l’employé. Type de données : chaîne |
|
| Identificateur d’employé | Identificateur unique de l’employé. Type de données : chaîne |
| Prénom | Prénom de l’employé. Type de données : chaîne |
| Date d’embauche | Date d’embauche de l’employé. Type de données : chaîne |
| Nom de famille | Nom de famille de l’employé. Type de données : chaîne |
| Deuxième prénom | Deuxième prénom de l’employé. Type de données : chaîne |
| Réembaucher | Pour une utilisation future. Type de données : chaîne |
| Adresse de résidence | Adresse postale du domicile de l’employé. Type de données : chaîne |
| Ville de résidence | Ville de résidence de l’employé. Type de données : chaîne |
| Pays de résidence | Pays d’origine de l’employé. Type de données : chaîne |
| RésidenceCode postal | Code postal du domicile de l’employé. Type de données : chaîne |
| État de résidence | État du domicile de l’employé. Type de données : chaîne |
| Suffixe | Suffixe de l’employé, tel que M., Mme ou Dr. Type de données : chaîne |
| Adresse de travail | Adresse postale au travail de l’employé. Type de données : chaîne |
| WorkCity | Ville de travail de l’employé Type de données : chaîne |
| WorkCountry | Pays de travail de l’employé. Type de données : chaîne |
| Code postal du travail | Code postal professionnel de l’employé. Type de données : chaîne |
| État de travail | État de travail de l’employé. Type de données : chaîne |
Exemple de demande cURL pour les informations d’un employé spécifique
curl -X GET "https://instance.servicenow.com/api/sn_hr_core/V1/hr_rest_api/get_usa_employee_profile?employee_identifier=231"
-H "accept: application/json" \
-u "username":"password"{"result": [
{
"EmployeeIdentifier": "231",
"FirstName": "Harold",
"MiddleName": "William",
"LastName": "Lewis",
"Suffix": "Mr.",
"Email": "Howard.Lewis@example.com",
"BirthDate": "",
"HireDate": "2021-02-18",
"Company": "ServiceNow Inc",
"ResidenceAddress": "",
"ResidenceCity": "SD",
"ResidenceState": "CA",
"ResidencePostalCode": "",
"ResidenceCountry": "",
"WorkAddress": "2617 South Robinson Avenue, Oklahoma City",
"WorkCity": "Oklahoma",
"WorkState": "OK",
"WorkPostalCode": "73109",
"WorkCountry": "USA",
"ReHire": ""
}
]}Exemple de demande cURL pour une liste d’employés ajoutés/mis à jour le 18/05/2019 ou après
curl -X GET "https://instance.servicenow.com/api/sn_hr_core/V1/hr_rest_api/get_usa_employee_profile?update_after=2019-05-18"
-H "accept: application/json" \
-u "username":"password"{"result": [
{
"EmployeeIdentifier": "2345",
"FirstName": "Cheryl",
"MiddleName": "Lynn",
"LastName": "Smith",
"Suffix": "Mrs.",
"Email": "Cheryl.Smith@example.com",
"BirthDate": "",
"HireDate": "2019-06-18",
"Company": "ServiceNow Inc",
"ResidenceAddress": "",
"ResidenceCity": "SD",
"ResidenceState": "CA",
"ResidencePostalCode": "",
"ResidenceCountry": "",
"WorkAddress": "2617 South Robinson Avenue, Oklahoma City",
"WorkCity": "Oklahoma",
"WorkState": "OK",
"WorkPostalCode": "73109",
"WorkCountry": "USA",
"ReHire": ""
},
{
"EmployeeIdentifier": "1111",
"FirstName": "Thomas",
"MiddleName": "",
"LastName": "Doe",
"Suffix": "Mr.",
"Email": "Thomas.Doe@example.com",
"BirthDate": "1978-05-22",
"HireDate": "2019-08-14",
"Company": "",
"ResidenceAddress": "",
"ResidenceCity": "San Jose",
"ResidenceState": "CA",
"ResidencePostalCode": "",
"ResidenceCountry": "",
"WorkAddress": "13308 Midland Road, Poway",
"WorkCity": "Poway",
"WorkState": "CA",
"WorkPostalCode": "",
"WorkCountry": "USA",
"ReHire": ""
}
]}