API ouverte de gestion des parties

Gestion des parties – DELETE /api/sn_tmf_api/v1/party/individual/{id}

Désactive un enregistrement spécifié des tables Consommateur [csm_consumer] et Contact [customer_contact].

Format d'URL

URL versionnée : /api/sn_tmf_api/{api_version}/party/individual/{id}

URL par défaut : /api/sn_tmf_api/v1/party/individual/{id}

Paramètres de demande pris en charge

Tableau 1. Paramètres de chemin d'accès
Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par exemple, `v1` ou `v2`. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison autre que la plus récente. Type de données : chaîne
id	Sys_id ou external_id de l’enregistrement Consommateur ou Contact à définir sur un état inactif. Table : consommateur [csm_consumer] et contact [customer_contact]. Type de données : chaîne

Tableau 2. Paramètres de requête
Nom	Description
Néant

Tableau 3. Paramètres de corps de demande (XML ou JSON)
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.

Tableau 4. En-têtes de demandes
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

Tableau 5. En-têtes de réponses
En-tête	Description
Néant

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.

Tableau 6. Codes d'état
Code d'état	Description
200	Réussi. La demande a été traitée avec succès.
400	Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté.

Paramètres du corps de la réponse (JSON ou XML)


Nom	Description
Néant

Demande cURL

L’exemple suivant supprime l’enregistrement donné.

curl "http://instance.service-now.com/api/sn_tmf_api/v1/party/individual/dca96eaa11f43110f877366201dea6c1" \
--request DELETE \
--header "Accept:application/json" \
--user 'user':'password' \

Ne renvoie pas de corps de réponse. Codes d’état de référence pour un indicateur de réussite ou d’échec.

Gestion des parties : GET /api/sn_tmf_api/v1/party/individual

Récupère une liste de tous les enregistrements individuels (parties) ayant une relation avec l’entreprise. Vous pouvez filtrer les résultats par champs ou ID spécifiques.

Format d'URL

URL versionnée : /api/sn_tmf_api/v1/party/individual

URL par défaut : /api/sn_tmf_api/v1/party/individual

Paramètres de demande pris en charge

Tableau 7. Paramètres de chemin d'accès
Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par exemple, `v1` ou `v2`. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison autre que la plus récente. Type de données : chaîne

Tableau 8. Paramètres de requête
Nom	Description
Champs	Liste des champs à renvoyer dans la réponse. Les champs non valides sont ignorés. Champs valides : @type nom de famille sexe givenName href id deuxième prénom nom nationalité statut Titre Type de données : chaîne Par défaut : renvoie tous les champs.
id	Filtrer la gestion des parties par sys_id. Les sys_ids spécifiés sont renvoyés dans la réponse. Type de données : chaîne
limite	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 offset . Type de données : nombre Par défaut : 20 Maximum : 100
décalage	Index de départ sur lequel commencer à récupérer les enregistrements. Utilisez cette valeur pour paginer la récupération de l’enregistrement. Type de données : nombre Par défaut : 0

Tableau 9. Paramètres de corps de demande (XML ou JSON)
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.

Tableau 10. En-têtes de demandes
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

Tableau 11. En-têtes de réponses
En-tête	Description
Plage de contenu	Plage de contenu renvoyé dans un appel paginé. Par exemple, si offset=2 et limit=3, la valeur de l’en-tête Content-Range est les éléments 3-5.
Type de contenu	Format de données du corps de la réponse. Prend uniquement en charge application/json.
un lien	Contient les liens suivants pour parcourir les résultats de la requête : premier dernier suivant previous
Nombre X-Total	Pour les requêtes paginées, cet en-tête spécifie le nombre total d’enregistrements disponibles sur le serveur.

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.

Tableau 12. Codes d'état
Code d'état	Description
200	Demande traitée avec succès. Ressource complète renvoyée en réponse (aucune pagination).
206	Ressource partielle renvoyée en réponse (avec pagination).
400	Demande incorrecte. Raisons possibles : Paramètre de chemin d’accès non valide URI non valide
404	Enregistrement introuvable. Aucun enregistrement correspondant aux paramètres de requête n’a été trouvé dans la table.

Paramètres du corps de la réponse (JSON ou XML)


Nom	Description
contactMedium	Liste des moyens de contacter la partie. Type de données : tableau d’objets `"contactMedium": [ { "@type": "String", "city": "String", "country": "String", "emailAddress": "String", "locationId": "String", "mediumType": "String", "phoneNumber": "String", "postCode": "String", "preferred": "Boolean", "stateOrProvince": "String", "street1": "String", "street2": "String" } ]`
contactMedium.@type	Type de partie qui contacte. Indique le type de schéma ou de sous-classe spécifique de l’objet. Valeurs possibles : BusinessPhoneContactMedium : numéro de téléphone professionnel EmailContactMedium : adresse e-mail FaxPhoneContactMedium : Numéro de fax GeographicAddressContactMedium : adresse physique (rue, ville, état, code postal) HomePhoneContactMedium : numéro de téléphone du domicile MobilePhoneContactMedium : Numéro de téléphone portable Type de données : chaîne
contactMedium.city	Ville de l’individu. Type de données : chaîne
contactMedium.country	Pays de la personne. Type de données : chaîne
contactMedium.emailAddress	Adresse e-mail du contact. Type de données : chaîne
contactMedium.locationId	Sys_id du lieu de la fête. Table : Emplacement [cmn_location] Type de données : chaîne
contactMedium.mediumType	Le type de milieu de contact. Indique l’attribut au niveau de l’entreprise qui spécifie le type de canal de contact utilisé. Valeurs possibles : e-mail téléphone professionnel Téléphone du domicile Téléphone mobile adresse postale Type de données : chaîne
contactMedium.numéroTéléphone	Numéro de téléphone de la personne. Type de données : chaîne
contactMedium.postCode	Code postal de la personne. Type de données : chaîne
contactMedium.preferred	Cette valeur est toujours fausse. Type de données : booléennes
contactMedium.stateOrProvince	Indique si l’emplacement est d’un État ou d’une province. Valeurs possibles : État Province (en anglais) Type de données : chaîne
contactMedium.street1	Décrit la rue. Type de données : chaîne
contactMedium.street2	Description complémentaire de la rue. Type de données : chaîne
nom de famille	Nom de famille de la personne. Type de données : chaîne
sexe	Sexe de la personne. Type de données : chaîne
givenName	Prénom de la personne. Type de données : chaîne
href	Lien relatif à l’enregistrement de l’utilisateur, du consommateur ou du contact. Type de données : chaîne
id	Sys_id de l’enregistrement de l’utilisateur, du consommateur ou du contact à récupérer. Tables : Consommateur [csm_consumer] ou Contact [customer_contact] Type de données : chaîne
deuxième prénom	Deuxième prénom de la personne. Type de données : chaîne
nom	Nom d’utilisateur de l’utilisateur ou de la personne à contacter. Type de données : chaîne
nationalité	Nationalité de la personne. Type de données : chaîne
partyCharacteristics	Liste des caractéristiques associées au parti. Type de données : tableau d’objets `"partyCharacteristics": [ { "@type": "String", "name": " String", "value": "String", "valueType": "String" } ]`
partyCharacteristics.@type	Lors de la sous-classe, cela définit le nom extensible de la sous-classe. Valeurs possibles : Caractéristique de chaîne Caractéristique du tableau de chaînes Caractéristique entière Caractéristique booléenne Type de données : chaîne
partyCharacteristics.name	Nom de la caractéristique de la partie. Type de données : chaîne
partyCharacteristics.valeur	Valeur de la caractéristique de la partie. Type de données : chaîne
partyCharacteristics.valueType	Type de données de la valeur de la caractéristique. Type de données : chaîne
partyOrPartyRole	Les rôles associés à cette partie sont définis où la partie est créée dans la table. Par exemple, `utilisateur`, `consommateur`, `contact client`. partyOrPartyRole Indique le type d’enregistrement récupéré dans l’opération. Si le sys_id fourni appartient à la table Consumer (Consommateur) [csm_consumer], il partyOrPartyRole.role est alors défini sur `Consumer (Consommateur`). De même, si le sys_id appartient à la table Contact [customer_contact], il partyOrPartyRole.role est défini sur `Contact`. Type de données : objet `"partyOrPartyRole": { "@type": "String", "role":"String" }`
partyOrPartyRole.@type	Cette valeur est toujours `Partie`. Type de données : chaîne
partyOrPartyRole.role	Type de rôle de la partie. Valeurs possibles : Consommateur Contact Type de données : chaîne
Fête connexe	Liste des parties ou des rôles de partie associés à cette partie. Type de données : tableau d’objets `"relatedParty": [ { "role": "String", "partyOrPartyRole": {Object} } ]`
relatedParty.partyOrPartyRole	Représente des informations sur la partie liée et le rôle qu’elle joue dans le contexte de l’enregistrement. Par exemple, si le rôle est `Société`, il partyOrPartyRole.id contient le sys_id de l’enregistrement Société [core_company] et partyOrPartyRole.name le nom de la société. Cette structure garantit que la référence au parti et son rôle sont explicitement définis et facilement identifiables. Type de données : objet `"partyOrPartyRole": { "@type": "String", "id": "String", "name": "String" }`
relatedParty.partyOrPartyRole.@type	Type de la partie liée. Valeur possible pour l’utilisateur : Organisation Individuel Type de données : chaîne
relatedParty.partyOrPartyRole.id	Sys_id de la partie liée. Valeur possible pour `l’utilisateur` : Société Département Valeur possible pour `le client` : compte Valeur possible pour `le consommateur` : utilisateur Type de données : chaîne
relatedParty.partyOrPartyRole.name	Nom de la partie liée. Type de données : chaîne
relatedParty.role	Rôle d’entreprise que la partie liée joue dans le contexte de l’entité actuelle. Valeurs possibles : Société (si la partie liée est l’utilisateur) Département (si la partie liée est l’utilisateur) Compte (si la partie liée est le client) Utilisateur (si la partie liée est un consommateur) Type de données : chaîne
statut	Marqueur qui indique l’état de la personne. Valeurs valides : actif : la personne a un statut actif. inactif : la personne est dans un état inactif. Type de données : booléennes
Titre	Préfixe ou titre de la personne. Par exemple, `Dr.`, `M.`, `Mme`). Type de données : chaîne

Demande cURL

Récupère une liste de tous les enregistrements de gestion des parties dans l’instance.

curl"http://instance.servicenow.com/api/v1/sn_tmf_api/party/individual" \
--request GET \
--header "Accept:application/json" \
--user 'user:password'

Corps de réponse pour une partie à contact individuel.

[
{
   "id": "34d92aaa11f43110f877366201dea67b",
   "href": "api/sn_tmf_api/party/individual/34d92aaa11f43110f877366201dea67b",
   "name": "carlos.star",
   "givenName": "Carlos",
   "middleName": "",
   "familyName": "Star",
   "gender": "",
   "title": "",
   "partyCharacteristics": [
     {
       "name": "notification",
       "value": "Enable",
       "valueType": "string",
       "@type": "StringCharacteristic"
     },
     {
       "name": "preferredLanguage",
       "value": "",
       "valueType": "string",
       "@type": "StringCharacteristic"
     },
     {
       "name": "dateFormat",
       "value": "",
       "valueType": "string",
       "@type": "StringCharacteristic"
     },
     {
       "name": "timeFormat",
       "value": "",
       "valueType": "string",
       "@type": "StringCharacteristic"
     },
     {
       "name": "timeZone",
       "value": "",
       "valueType": "string",
       "@type": "StringCharacteristic"
     },
     {
       "name": "vip",
       "value": false,
       "valueType": "boolean",
       "@type": "BooleanCharacteristic"
     },
     {
       "name": "webServiceAccessOnly",
       "value": false,
       "valueType": "boolean",
       "@type": "BooleanCharacteristic"
     },
     {
       "name": "source",
       "value": "",
       "valueType": "string",
       "@type": "StringCharacteristic"
     },
     {
       "name": "eduStatus",
       "value": "Faculty",
       "valueType": "string",
       "@type": "StringCharacteristic"
     }
   ],
   "contactMedium": [
     {
       "preferred": false,
       "mediumType": "email",
       "emailAddress": "carlos.star@example.com",
       "@type": "EmailContactMedium"
     },
     {
       "preferred": false,
       "mediumType": "businessPhone",
       "phoneNumber": "",
       "@type": "BusinessPhoneContactMedium"
     },
     {
       "preferred": false,
       "mediumType": "homePhone",
       "phoneNumber": "",
       "@type": "HomePhoneContactMedium"
     },
     {
       "preferred": false,
       "mediumType": "mobilePhone",
       "phoneNumber": "",
       "@type": "MobilePhoneContactMedium"
     }
   ],
   "externalReference": [],
   "relatedParty": [
     {
       "role": "Company",
       "partyOrPartyRole": {
         "id": "9e2fd2ee11b43110f877366201dea674",
         "name": "Startech svcs",
         "@type": "Organization"
       }
     },
     {
       "role": "Department",
       "partyOrPartyRole": {
         "id": "",
         "name": "",
         "@type": "Organization"
       }
     }
   ],
   "status": "Active",
   "@type": "Individual",
   "partyOrPartyRole": {
     "name": "Contact",
     "@type": "Party"
   }
 }
]

Corps de réponse pour une partie de consommateur individuel.

[
{
   "id": "168bfc6953a46210132bddeeff7b129f",
   "href": "api/sn_tmf_api/party/individual/168bfc6953a46210132bddeeff7b129f",
   "givenName": "yyyg",
   "middleName": "hhh",
   "familyName": "bhhhbjhh",
   "gender": "",
   "nationality": "",
   "title": "",
   "partyCharacteristics": [
     {
       "name": "notes",
       "value": "",
       "valueType": "string",
       "@type": "StringCharacteristic"
     },
     {
       "name": "user",
       "value": "",
       "valueType": "string",
       "@type": "StringCharacteristic"
     },
     {
       "name": "notification",
       "value": "Enable",
       "valueType": "string",
       "@type": "StringCharacteristic"
     },
     {
       "name": "preferredLanguage",
       "value": "",
       "valueType": "string",
       "@type": "StringCharacteristic"
     },
     {
       "name": "dateFormat",
       "value": "",
       "valueType": "string",
       "@type": "StringCharacteristic"
     },
     {
       "name": "timeFormat",
       "value": "",
       "valueType": "string",
       "@type": "StringCharacteristic"
     },
     {
       "name": "timeZone",
       "value": "",
       "valueType": "string",
       "@type": "StringCharacteristic"
     }
   ],
   "contactMedium": [
     {
       "preferred": false,
       "mediumType": "businessPhone",
       "phoneNumber": "",
       "@type": "BusinessPhoneContactMedium"
     },
     {
       "preferred": false,
       "mediumType": "homePhone",
       "phoneNumber": "",
       "@type": "HomePhoneContactMedium"
     },
     {
       "preferred": false,
       "mediumType": "mobilePhone",
       "phoneNumber": "",
       "@type": "MobilePhoneContactMedium"
     },
     {
       "preferred": false,
       "mediumType": "fax",
       "phoneNumber": "",
       "@type": "FaxContactMedium"
     },
     {
       "preferred": false,
       "mediumType": "postalAddress",
       "@type": "GeographicalAddressContactMedium",
       "city": "ygyg",
       "locationId": "a39bfc6953a46210132bddeeff7b12b7",
       "country": "",
       "postCode": "hh",
       "stateOrProvince": "gyg",
       "street1": "hgg",
       "street2": ""
     }
   ],
   "externalReference": [],
   "relatedParty": [
     {
       "role": "User",
       "partyOrPartyRole": {
         "id": "",
         "name": "",
         "@type": "Individual"
       }
     }
   ],
   "status": "Active",
   "@type": "Individual",
   "partyOrPartyRole": {
     "name": "Consumer",
     "@type": "Party"
   }
 }
]

Gestion des parties : GET /api/sn_tmf_api/v1/party/individual/{id}

Récupère un enregistrement spécifié dans les tables Consommateur [csm_consumer] ou Contact [customer_contact]. Vous pouvez filtrer les résultats en fonction de champs spécifiques.

Format d'URL

URL versionnée : /api/sn_tmf_api/{api_version}/party/individual

URL par défaut : /api/sn_tmf_api/v1/party/individual

Paramètres de demande pris en charge

Tableau 13. Paramètres de chemin d'accès
Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par exemple, `v1` ou `v2`. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison autre que la plus récente. Type de données : chaîne
id	Sys_id ou external_id de l’enregistrement du consommateur ou du contact à récupérer. Table : Consommateur [csm_consumer] ou contact [customer_contact] Type de données : chaîne

Tableau 14. Paramètres de requête
Nom	Description
Champs	Liste des champs à renvoyer dans la réponse. Les champs non valides sont ignorés. Champs valides : @type nom de famille sexe givenName href id deuxième prénom nom nationalité statut Titre Type de données : chaîne Par défaut : renvoie tous les champs

Tableau 15. Paramètres de corps de demande (XML ou JSON)
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.

Tableau 16. En-têtes de demandes
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

Tableau 17. En-têtes de réponses
En-tête	Description
Néant

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.

Tableau 18. Codes d'état
Code d'état	Description
200	Réussi. La demande a été traitée avec succès.

Paramètres du corps de la réponse (JSON ou XML)


Nom	Description
contactMedium	Liste des moyens de contacter la partie. Type de données : tableau d’objets `"contactMedium": [ { "@type": "String", "city": "String", "country": "String", "emailAddress": "String", "locationId": "String", "mediumType": "String", "phoneNumber": "String", "postCode": "String", "preferred": "Boolean", "stateOrProvince": "String", "street1": "String", "street2": "String" } ]`
contactMedium.@type	Type de partie qui contacte. Indique le type de schéma ou de sous-classe spécifique de l’objet. Valeurs possibles : BusinessPhoneContactMedium : numéro de téléphone professionnel EmailContactMedium : adresse e-mail FaxPhoneContactMedium : Numéro de fax GeographicAddressContactMedium : adresse physique (rue, ville, état, code postal) HomePhoneContactMedium : numéro de téléphone du domicile MobilePhoneContactMedium : Numéro de téléphone portable Type de données : chaîne
contactMedium.city	Ville de l’individu. Type de données : chaîne
contactMedium.country	Pays de la personne. Type de données : chaîne
contactMedium.emailAddress	Adresse e-mail du contact. Type de données : chaîne
contactMedium.locationId	Sys_id du lieu de la fête. Table : Emplacement [cmn_location] Type de données : chaîne
contactMedium.mediumType	Le type de milieu de contact. Indique l’attribut au niveau de l’entreprise qui spécifie le type de canal de contact utilisé. Valeurs possibles : e-mail téléphone professionnel Téléphone du domicile Téléphone mobile adresse postale Type de données : chaîne
contactMedium.numéroTéléphone	Numéro de téléphone de la personne. Type de données : chaîne
contactMedium.postCode	Code postal de la personne. Type de données : chaîne
contactMedium.preferred	Cette valeur est toujours fausse. Type de données : booléennes
contactMedium.stateOrProvince	Indique si l’emplacement est d’un État ou d’une province. Valeurs possibles : État Province (en anglais) Type de données : chaîne
contactMedium.street1	Décrit la rue. Type de données : chaîne
contactMedium.street2	Description complémentaire de la rue. Type de données : chaîne
nom de famille	Nom de famille de la personne. Type de données : chaîne
sexe	Sexe de la personne. Type de données : chaîne
givenName	Prénom de la personne. Type de données : chaîne
href	Lien relatif à l’enregistrement de l’utilisateur, du consommateur ou du contact. Type de données : chaîne
id	Sys_id de l’enregistrement de l’utilisateur, du consommateur ou du contact à récupérer. Tables : Consommateur [csm_consumer] ou Contact [customer_contact] Type de données : chaîne
deuxième prénom	Deuxième prénom de la personne. Type de données : chaîne
nom	Nom d’utilisateur de l’utilisateur ou de la personne à contacter. Type de données : chaîne
nationalité	Nationalité de la personne. Type de données : chaîne
partyCharacteristics	Liste des caractéristiques associées au parti. Type de données : tableau d’objets `"partyCharacteristics": [ { "@type": "String", "name": " String", "value": "String", "valueType": "String" } ]`
partyCharacteristics.@type	Lors de la sous-classe, cela définit le nom extensible de la sous-classe. Valeurs possibles : Caractéristique de chaîne Caractéristique du tableau de chaînes Caractéristique entière Caractéristique booléenne Type de données : chaîne
partyCharacteristics.name	Nom de la caractéristique de la partie. Type de données : chaîne
partyCharacteristics.valeur	Valeur de la caractéristique de la partie. Type de données : chaîne
partyCharacteristics.valueType	Type de données de la valeur de la caractéristique. Type de données : chaîne
partyOrPartyRole	Les rôles associés à cette partie sont définis où la partie est créée dans la table. Par exemple, `utilisateur`, `consommateur`, `contact client`. partyOrPartyRole Indique le type d’enregistrement récupéré dans l’opération. Si le sys_id fourni appartient à la table Consumer (Consommateur) [csm_consumer], il partyOrPartyRole.role est alors défini sur `Consumer (Consommateur`). De même, si le sys_id appartient à la table Contact [customer_contact], il partyOrPartyRole.role est défini sur `Contact`. Type de données : objet `"partyOrPartyRole": { "@type": "String", "role":"String" }`
partyOrPartyRole.@type	Cette valeur est toujours `Partie`. Type de données : chaîne
partyOrPartyRole.role	Type de rôle de la partie. Valeurs possibles : Consommateur Contact Type de données : chaîne
Fête connexe	Liste des parties ou des rôles de partie associés à cette partie. Type de données : tableau d’objets `"relatedParty": [ { "role": "String", "partyOrPartyRole": {Object} } ]`
relatedParty.partyOrPartyRole	Représente des informations sur la partie liée et le rôle qu’elle joue dans le contexte de l’enregistrement. Par exemple, si le rôle est `Société`, il partyOrPartyRole.id contient le sys_id de l’enregistrement Société [core_company] et partyOrPartyRole.name le nom de la société. Cette structure garantit que la référence au parti et son rôle sont explicitement définis et facilement identifiables. Type de données : objet `"partyOrPartyRole": { "@type": "String", "id": "String", "name": "String" }`
relatedParty.partyOrPartyRole.@type	Type de la partie liée. Valeur possible pour l’utilisateur : Organisation Individuel Type de données : chaîne
relatedParty.partyOrPartyRole.id	Sys_id de la partie liée. Valeur possible pour `l’utilisateur` : Société Département Valeur possible pour `le client` : compte Valeur possible pour `le consommateur` : utilisateur Type de données : chaîne
relatedParty.partyOrPartyRole.name	Nom de la partie liée. Type de données : chaîne
relatedParty.role	Rôle d’entreprise que la partie liée joue dans le contexte de l’entité actuelle. Valeurs possibles : Société (si la partie liée est l’utilisateur) Département (si la partie liée est l’utilisateur) Compte (si la partie liée est le client) Utilisateur (si la partie liée est un consommateur) Type de données : chaîne
statut	Marqueur qui indique l’état de la personne. Valeurs valides : actif : la personne a un statut actif. inactif : la personne est dans un état inactif. Type de données : booléennes
Titre	Préfixe ou titre de la personne. Par exemple, `Dr.`, `M.`, `Mme`). Type de données : chaîne

Demande cURL

Récupère un enregistrement spécifié, 12345, à partir de la table.

curl "http://instance.servicenow.com/api/sn_tmf_api/v1/party/individual/12345" \
--request GET \
--header "Accept:application/json" \
--user 'user':'password' \

Corps de la réponse.

{
  "id": "12345",
  "givenName": "JohnTest6",
  "middleName": "A.",
  "familyName": "Doe",
  "gender": "male",
  "nationality": "American",
  "title": "Mr",
  "contactMedium": [
    {
      "preferred": true,
      "mediumType": "email",
      "emailAddress": "john.doe18723@example.com",
      "@type": "EmailContactMedium"
    },
    {
      "preferred": false,
      "mediumType": "mobilePhone",
      "phoneNumber": "+1-202-555-0198",
      "@type": "PhoneContactMedium"
    },
    {
      "preferred": false,
      "mediumType": "businessPhone",
      "phoneNumber": "+1-202-555-0198",
      "@type": "BusinessPhoneContactMedium"
    },
    {
      "preferred":false,
      "mediumType":"faxPhone",
      "phoneNumber":"123456789",
      "@type":"FaxContactMedium"
    },
    {
      "preferred": false,
      "mediumType": "homePhone",
      "phoneNumber": "+1-202-555-0198",
      "@type": "HomePhoneContactMedium"
    },
    {
      "preferred": false,
      "mediumType": "postalAddress",
      "@type": "GeographicAddressContactMedium",
      "locationId":"25ab9e240a0a0bb3009eb9ef8dd0a2c0",
      "city": "Town",
      "country": "USA",
      "postCode": "07960",
      "stateOrProvince": "New Jersey",
      "street1": "1820 Harris Houston Road, Charlotte",
      "street2": "East Tower - 10th Floor"
    },
    {
      "preferred": false,
      "mediumType": "postalAddress",
      "@type": "GeographicAddressContactMedium",
      "locationId":"25aba17a0a0a0bb3007efd809d6e695c",
      "city": "Webster",
      "country": "USA",
      "postCode": "76022",
      "stateOrProvince": "TN",
      "street1": "17077 Texas Avenue, Webster",
      "street2": "East Tower - 11th Floor"
    }
  ],
  "externalReference": [
    {
      "externalIdentifierType": "facebook",
      "id": "http://facebook.com/johndoe"
    }
  ],
  "partyCharacteristic": [
    {
      "name": "notes",
      "value": "notes about the consumer",
      "valueType": "string",
      "@type": "string"
    },
    {
      "name": "dateFormat",
      "value": "dd-mm-yyyy",
      "valueType": "string",
      "@type": "string"
    },
    {
      "name": "timeformat",
      "value": "hh.mm.ss (12 hour)",
      "valueType": "string",
      "@type": "string"
    },
    {
      "name": "notification",
      "value": "Enable",
      "valueType": "string",
      "@type": "string"
    }
  ],
  "relatedParty": [
    {
      "role": "User",
      "partyOrPartyRole": {
        "id": "36901a6381116a50f8776cfcbee15f3c",
        "name": "Hr",
        "@type": "Individual"
      }
    }
  ],
  "status": "active",
  "@type": "Individual",
  "partyOrPartyRole": {
    "role": "Consumer",
    "@type":"Party"
  }
}

Gestion des parties : GET/api/ sn_tmf_api/v1/party/organization/{id}

Récupère un enregistrement spécifié dans les tables Compte [customer_account]. Vous pouvez filtrer les résultats par champs ou ID spécifiques.

Format d'URL

URL versionnée : /api/sn_tmf_api/v1/party/organization/{id}

URL par défaut : /api/sn_tmf_api/v1/party/organization/{id}

Paramètres de demande pris en charge

Tableau 19. Paramètres de chemin d'accès
Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par exemple, `v1` ou `v2`. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison autre que la plus récente. Type de données : chaîne
id	Sys_id de l’enregistrement de compte ou de société à récupérer. Table : compte [customer_account] ou société [csm_company] Type de données : chaîne

Tableau 20. Paramètres de requête
Nom	Description
Champs	Liste des champs à renvoyer dans la réponse. Les champs non valides sont ignorés. Champs valides : @type href id nom légal nom statut Nom du trading Type de données : chaîne Par défaut : renvoie tous les champs
id	Filtrer la gestion des parties par sys_id. Les sys_ids spécifiés sont renvoyés dans la réponse. Type de données : chaîne
limite	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 offset . Type de données : nombre Par défaut : 20 Maximum : 100
décalage	Index de départ sur lequel commencer à récupérer les 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. Type de données : nombre Par défaut : 0

Tableau 21. Paramètres de corps de demande (XML ou JSON)
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.

Tableau 22. En-têtes de demandes
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

Tableau 23. En-têtes de réponses
En-tête	Description
Néant

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.

Tableau 24. Codes d'état
Code d'état	Description
200	Réussi. La demande a été traitée avec succès.

Paramètres du corps de la réponse (JSON ou XML)


Nom	Description
@type	Cette valeur est toujours `Organisation`. Type de données : chaîne
contactMedium	Liste des moyens de contacter la partie. Un moyen de contact représente la façon dont vous communiquez ou atteignez une partie comme une personne ou une organisation. Par exemple, un canal ou une méthode de contact associé à cette partie. Type de données : tableau d’objets `"contactMedium": [ { "@type": "String", "city": "String", "country": "String", "emailAddress": "String", "locationId": "String", "mediumType": "String", "phoneNumber": "String", "postCode": "String", "preferred": "Boolean", "stateOrProvince": "String", "street1": "String", "street2": "String" } ]`
contactMedium.@type	Type de support de contact. Type de partie qui contacte. Indique le type de schéma ou de sous-classe spécifique de l’objet. Valeurs possibles : BusinessPhoneContactMedium : numéro de téléphone professionnel EmailContactMedium : adresse e-mail FaxPhoneContactMedium : Numéro de fax GeographicAddressContactMedium : adresse physique (rue, ville, état, code postal) HomePhoneContactMedium : numéro de téléphone du domicile MobilePhoneContactMedium : Numéro de téléphone portable Type de données : chaîne
contactMedium.city	Ville de l’organisation. Type de données : chaîne
contactMedium.country	Pays de l’organisation. Type de données : chaîne
contactMedium.emailAdress	Adresse e-mail du contact de l’organisation. Type de données : chaîne
contactMedium.locationId	Sys_id de l’emplacement. Table : Emplacement [cmn_location] Type de données : chaîne
contactMedium.mediumType	Le type de milieu de contact. Valeurs possibles : téléphone professionnel e-mail faxPhone Téléphone du domicile Téléphone mobile adresse postale Type de données : chaîne
contactMedium.numéroTéléphone	Numéro de téléphone du contact de l’organisation. Type de données : chaîne
contactMedium.postCode	Code postal de l’organisation. Type de données : chaîne
contactMedium.preferred	Cette valeur est toujours `fausse`. Type de données : booléennes
contactMedium.stateOrProvince	Indique si l’emplacement est d’un État ou d’une province. Valeurs possibles : État Province (en anglais) Type de données : chaîne
contactMedium.street1	Décrit la rue. Type de données : chaîne
contactMedium.street2	Description complémentaire de la rue. Type de données : chaîne
Référence externe	Liste des identificateurs de la partie dans un système externe. Type de données : tableau d’objets `"externalReference": [ { "externalIdentifierType": "String", "name": "String" } ]`
Référenceexterne.TypeIdentificateur externe	Type d’entité au sein du système externe. Type de données : chaîne
externalReference.name	Nom explicite du système externe ou de la référence. Type de données : chaîne
href	Lien relatif à l’enregistrement de compte (URI). Table : Compte [customer_account] Type de données : chaîne
id	Sys_id de l’enregistrement du compte d’entité externe. Table : Compte [customer_account] Type de données : chaîne
nom légal	Nom juridique de l’organisation. Type de données : chaîne
nom	Nom de l’organisation. Type de données : chaîne
partyCharacteristics	Liste des caractéristiques qu’un groupe peut adopter. Type de données : tableau d’objets `"partyCharacteristics": [ { "@type": "String" "name": "String", "value": "String", "valueType": "String" } ]`
partyCharacteristics.@type	Lors de la sous-classe, @type définit le nom extensible de la sous-classe. Valeur possible : Caractéristique booléenne Caractéristique entière Caractéristique du tableau de chaînes Caractéristique de chaîne Type de données : chaîne
partyCharacteristics.name	Nom de la caractéristique de la partie. Type de données : chaîne
partyCharacteristics.valeur	Valeur de la caractéristique de la partie. Type de données : chaîne
partyCharacteristics.valueType	Type de données de la valeur de la caractéristique. Type de données : chaîne
partyOrPartyRole	Les rôles associés à cette partie sont définis à l’endroit où la partie est créée dans la table. Par exemple, `Société` ou `Compte`. partyOrPartyRole Indique le type d’enregistrement récupéré dans l’opération. Si le sys_id fourni appartient à la table Compte [customer_account], alors partyOrPartyRole.role il est défini sur `Compte`. De même, si le sys_id appartient à la table Société [core_company], il partyOrPartyRole.role est défini sur `Société`. Type de données : objet `"partyOrPartyRole": { "@type": "String", "name":"String", "role":"String", }`
PartyOrPartyRole.@type	Cette valeur est toujours `fête`. Type de données : chaîne
PartyOrPartyRole.name	Définit le type de compte ou de société. Type de données : chaîne
PartyOrPartyRole.role	Type de rôle. Valeur possible : Compte Société Type de données : chaîne
Fête connexe	Liste des parties ou des rôles de partie associés à cette partie. Type de données : tableau d’objets `"relatedParty": [ { "partyOrPartyRole": {Object}, "role": "String" } ]`
relatedParty.partyOrPartyRole	Rôles associés à cette partie. Type de données : tableau d’objets `"partyOrPartyRole": [ { "@type": "String", "id": "String", "name": "String", } ]`
relatedParty.partyOrPartyRole.@type	Type de la partie liée. La valeur est toujours `Organisation`. Type de données : chaîne
relatedParty.partyOrPartyRole.id	Sys_id de la partie liée. Valeur possible : Contact Autre Type de données : chaîne
relatedParty.partyOrPartyRole.name	Nom de la partie liée. Type de données : chaîne
relatedParty.role	Rôle joué par la partie liée ou le rôle de partie dans le contexte de l’entité spécifique à laquelle il est lié. Valeurs possibles : Contact Autre Type de données : chaîne
statut	Marqueur qui indique l’état de l’organisation. Valeurs valides : actif : l’organisation est active. inactif : l’organisation est inactive. Type de données : booléennes
Nom du trading	Nom sous lequel l’organisation exerce ses activités. Type de données : chaîne

Demande cURL

L’appel GET suivant renvoie les champs de l’enregistrement spécifié de l’organisation de gestion des parties avec le sys_id, 12345.

curl "http://instance.servicenow.com/api/sn_tmf_api/v1/party/organization/12345" \
--request GET \
--header "Accept:application/json" \
--user 'user':'password' \

Corps de la réponse.

{
   "id": "2154376",
   "name": "Advances Super Computing",
   "href": "api/sn_tmf_api/party/organization/2154376",
   "legalName": "Hello",
   "tradingName": "World",
   "contactMedium": [
     {
       "preferred": "false",
       "mediumType": "email",
       "@type": "EmailContactMedium",
       "emailAddress": "user@servicenow.com"
     },
     {
       "preferred": "false",
       "mediumType": "phone",
       "@type": "PhoneContactMedium",
       "phone": "(555) 555-5555"
     },
     {
       "preferred": "false",
       "mediumType": "faxPhone",
       "@type": "FaxPhoneContactMedium",
       "fax_phone": ""
     }
   ],
   "externalReference": [
     {
       "externalIdentifierType": "Facebook",
       "name": "facebook.com"
     },
     {
       "externalIdentifierType": "Twitter",
       "name": "twitter.com"
     }
   ],
   "partyCharacteristic": [
     {
       "name": "notes",
       "value": "efdxcjkn ",
       "valueType": "string",
       "@type": "StringCharacteristic"
     },
     {
       "name": "registrationCode",
       "value": "23456789",
       "valueType": "string",
       "@type": "StringCharacteristic"
     },
     {
       "name": "accountCode",
       "value": "####30",
       "valueType": "string",
       "@type": "StringCharacteristic"
     },
     {
       "name": "identificationNumber",
       "value": "",
       "valueType": "string",
       "@type": "StringCharacteristic"
     },
     {
       "name": "taxId",
       "value": "",
       "valueType": "string",
       "@type": "StringCharacteristic"
     },
     {
       "name": "industry",
       "value": "",
       "valueType": "choice",
       "@type": "StringCharacteristic"
     },
     {
       "name": "numEmployees",
       "value": "",
       "valueType": "integer",
       "@type": "IntergerCharacteristic"
     },
     {
       "name": "rankTier",
       "value": "",
       "valueType": "string",
       "@type": "StringCharacteristic"
     },
     {
       "name": "publiclyTraded",
       "value": "false",
       "valueType": "boolean",
       "@type": "BooleanCharacteristic"
     },
     {
       "name": "stockSymbol",
       "value": "",
       "valueType": "string",
       "@type": "StringCharacteristic"
     },
     {
       "name": "stockPrice",
       "value": "",
       "valueType": "string",
       "@type": "StringCharacteristic"
     },
     {
       "name": "vendorType",
       "value": "Services, Applications",
       "valueType": "list",
       "@type": "StringArrayCharacteristic"
     },
     {
       "name": "marketCap",
       "value": "0",
       "valueType": "string",
       "@type": "StringCharacteristic"
     },
     {
       "name": "profits",
       "value": "0",
       "valueType": "string",
       "@type": "StringCharacteristic"
     },
     {
       "name": "revenuePerYear",
       "value": "0",
       "valueType": "string",
       "@type": "StringCharacteristic"
     },
     {
       "name": "website",
       "value": "sdfgh.com",
       "valueType": "string",
       "@type": "StringCharacteristic"
     }
   ],
   "relatedParty": [
     {
       "role": "primary",
       "partyOrPartyRole": {
         "@type": "Organization",
         "id": "b88d14843bc02300bfe04d72f3efc4cd",
         "name": "Amy Chen"
       }
     },
     {
       "role": "other",
       "partyOrPartyRole": {
         "@type": "Organization",
         "id": "016b7a36ff14a610f8dfffffffffffcb",
         "name": "Kutty"
       }
     },
     {
       "role": "other",
       "partyOrPartyRole": {
         "@type": "Organization",
         "id": "e8bb9d1aff94a210f8dfffffffffff1d",
         "name": "World"
       }
     }
   ],
   "organizationChildRelationship": [
     {
       "relationshipType": "partner_account",
       "organization": {
         "id": "9e2fd2ee11b43110f877366201dea674",
         "name": "Startech svcs",
         "href": "api/sn_tmf_api/party/organization/9e2fd2ee11b43110f877366201dea674",
         "@type": "Organization"
       }
     },
     {
       "relationshipType": "New type",
       "organization": {
         "id": "9e2fd2ee11b43110f877366201dea674",
         "name": "Startech svcs",
         "href": "api/sn_tmf_api/party/organization/9e2fd2ee11b43110f877366201dea674",
         "@type": "Organization"
       }
     },
     {
       "relationshipType": "child",
       "organization": {
         "id": "9e2fd2ee11b43110f877366201dea674",
         "name": "Startech svcs",
         "href": "api/sn_tmf_api/party/organization/null",
         "@type": "Organization"
       }
     }
   ],
   "organizationParentRelationship": {
     "relationshipType": "parent",
     "organization": {
       "id": "ffc68911c35420105252716b7d40dd55",
       "name": "Funco Intl",
       "href": "undefinedffc68911c35420105252716b7d40dd55",
       "@type": "Organization"
     }
   },
   "status": "inActive",
   "@type": "Organization",
   "partyOrPartyRole": {
     "name": "customer_partner_vendor_manufacturer",
     "role": "Account",
     "@type": "Party"
   }
 }

Gestion des parties : GET /api/sn_tmf_api/v1/party/organization

Récupère les enregistrements de partie au niveau de l’organisation à partir des tables Société [core_company] et Compte [customer_account]. Vous pouvez filtrer les résultats par champs ou ID spécifiques.

Format d'URL

URL avec version : /api/sn_tmf_api/v1/party/organization

URL par défaut : /api/sn_tmf_api/v1/party/organization

Paramètres de demande pris en charge

Tableau 25. Paramètres de chemin d'accès
Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par exemple, `v1` ou `v2`. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison autre que la plus récente. Type de données : chaîne

Tableau 26. Paramètres de requête
Nom	Description
Champs	Liste des champs à renvoyer dans la réponse. Les champs non valides sont ignorés. Champs valides : @type href id nom légal nom statut Nom du trading Type de données : chaîne Par défaut : renvoie tous les champs
id	Filtrer la gestion des parties par sys_id. Les sys_ids spécifiés sont renvoyés dans la réponse. Type de données : chaîne
limite	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 offset . Type de données : nombre Par défaut : 20 Maximum : 100
décalage	Index de départ sur lequel commencer à récupérer les 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. Type de données : nombre Par défaut : 0

Tableau 27. Paramètres de corps de demande (XML ou JSON)
Nom	Description
contactMedium	Liste des moyens de contacter la partie. Type de données : tableau d’objets `"contactMedium": [ { "@type": "String", "city": "String", "country": "String", "emailAddress": "String", "locationId": "String", "mediumType": "String", "phoneNumber": "String", "postCode": "String", "preferred": "Boolean", "stateOrProvince": "String", "street1": "String", "street2": "String" } ]`
contactMedium.@type	Type de partie qui contacte. Indique le type de schéma ou de sous-classe spécifique de l’objet. Valeurs possibles : BusinessPhoneContactMedium : numéro de téléphone professionnel EmailContactMedium : adresse e-mail FaxPhoneContactMedium : Numéro de fax GeographicAddressContactMedium : adresse physique (rue, ville, état, code postal) HomePhoneContactMedium : numéro de téléphone du domicile MobilePhoneContactMedium : Numéro de téléphone portable Type de données : chaîne
contactMedium.city	Ville de l’individu. Type de données : chaîne
contactMedium.country	Pays de la personne. Type de données : chaîne
contactMedium.emailAddress	Adresse e-mail du contact. Type de données : chaîne
contactMedium.locationId	Sys_id du lieu de la fête. Table : Emplacement [cmn_location] Type de données : chaîne
contactMedium.mediumType	Le type de milieu de contact. Indique l’attribut au niveau de l’entreprise qui spécifie le type de canal de contact utilisé. Valeurs possibles : e-mail téléphone professionnel Téléphone du domicile Téléphone mobile adresse postale Type de données : chaîne
contactMedium.numéroTéléphone	Numéro de téléphone de la personne. Type de données : chaîne
contactMedium.postCode	Code postal de la personne. Type de données : chaîne
contactMedium.preferred	Cette valeur est toujours fausse. Type de données : booléennes
contactMedium.stateOrProvince	Indique si l’emplacement se trouve dans un État ou une province. Valeurs possibles : État Province (en anglais) Type de données : chaîne
contactMedium.street1	Décrit la rue. Type de données : chaîne
contactMedium.street2	Description complémentaire de la rue. Type de données : chaîne
nom de famille	Nom de famille de la personne. Type de données : chaîne
sexe	Sexe de la personne. Type de données : chaîne
givenName	Prénom de la personne. Type de données : chaîne
href	Lien relatif à l’enregistrement de l’utilisateur, du consommateur ou du contact. Type de données : chaîne
deuxième prénom	Deuxième prénom de la personne. Type de données : chaîne
nom	Nom d’utilisateur de l’utilisateur ou de la personne à contacter. Type de données : chaîne
nationalité	Nationalité de la personne. Type de données : chaîne
partyCharacteristics	Liste des caractéristiques associées au parti. Type de données : tableau d’objets `"partyCharacteristics": [ { "@type": "String", "name": " String", "value": "String", "valueType": "String" } ]`
partyCharacteristics.@type	Lors de la sous-classe, ce paramètre définit le nom extensible de la sous-classe. Valeurs possibles : Caractéristique de chaîne Caractéristique du tableau de chaînes Caractéristique entière Caractéristique booléenne Type de données : chaîne
partyCharacteristics.name	Nom de la caractéristique de la partie. Type de données : chaîne
partyCharacteristics.valeur	Valeur de la caractéristique de la partie. Type de données : chaîne
partyCharacteristics.valueType	Type de données de la valeur de la caractéristique. Type de données : chaîne
partyOrPartyRole	Les rôles associés à cette partie sont définis où la partie est créée dans la table. Par exemple, `utilisateur`, `consommateur`, `contact client`. partyOrPartyRole Indique le type d’enregistrement récupéré dans l’opération. Si le sys_id fourni appartient à la table Consumer (Consommateur) [csm_consumer], il partyOrPartyRole.role est alors défini sur `Consumer (Consommateur`). De même, si le sys_id appartient à la table Contact [customer_contact], il partyOrPartyRole.role est défini sur `Contact`. Type de données : objet `"partyOrPartyRole": { "@type": "String", "role":"String" }`
partyOrPartyRole.@type	Cette valeur est toujours `Partie`. Type de données : chaîne
partyOrPartyRole.role	Type de rôle. Valeurs possibles : Consommateur Contact Type de données : chaîne
Fête connexe	Liste des parties et des rôles de parties associés à cette partie. Type de données : tableau d’objets `"relatedParty": [ { "role": "String", "partyOrPartyRole": {Object} } ]`
relatedParty.partyOrPartyRole.@type	Type de la partie liée. Valeur possible pour l’utilisateur : Organisation Individuel Type de données : chaîne
relatedParty.partyOrPartyRole.id	ID de l’entité liée dans le système de gestion des parties ou de gestion des rôles des parties. Valeur possible pour l’utilisateur : `Société` `Département` Valeur possible pour le client : `compte` Valeur possible pour le consommateur : `utilisateur` Type de données : chaîne
relatedParty.partyOrPartyRole.name	Nom de la partie liée. Type de données : chaîne
relatedParty.role	Rôle d’entreprise que la partie liée joue dans le contexte de l’entité actuelle. Valeurs possibles : Société (si la partie liée est l’utilisateur) Département (si la partie liée est l’utilisateur) Compte (si la partie liée est le client) Utilisateur (si la partie liée est un consommateur) Type de données : chaîne
statut	Marqueur qui indique l’état de la personne. Valeurs valides : actif : la personne a un statut actif. inactif : la personne n’a pas un état actif. Type de données : booléennes
Titre	Préfixe ou titre de la personne. Par exemple, `Dr.`, `M.`, `Mme`). Type de données : chaîne

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.

Tableau 28. En-têtes de demandes
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

Tableau 29. En-têtes de réponses
En-tête	Description
Néant

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.

Tableau 30. Codes d'état
Code d'état	Description
200	Réussi. La demande a été traitée avec succès.

Paramètres du corps de la réponse (JSON ou XML)


Nom	Description
Néant

Demande cURL

Renvoie tous les enregistrements d’organisation associés à l’entreprise.

curl"http://instance.servicenow.com/api/sn_tmf_api/v1/party/organization" \
--request GET \
--header "Accept:application/json" \
--user 'user':'password'

Corps de la réponse.

[
  {
    "id": "0bd6717c184da610f87765359bc696d3",
    "name": "SERVICENOW 144",
    "href": "api/sn_tmf_api/party/organization0bd6717c184da610f87765359bc696d3",
    "legalName": "",
    "tradingName": "",
    "contactMedium": [
      {
        "preferred": "false",
        "mediumType": "email",
        "@type": "EmailContactMedium",
        "emailAddress": "user@email.com"
      },
      {
        "preferred": "false",
        "mediumType": "phone",
        "@type": "PhoneContactMedium",
        "phone": "+1-555-555-5555"
      },
      {
        "preferred": "false",
        "mediumType": "faxPhone",
        "@type": "FaxPhoneContactMedium",
        "fax_phone": ""
      }
    ],
    "externalReference": [
      {
        "externalIdentifierType": "Instagram",
        "name": ""
      }
    ],
    "partyCharacteristic": [
      {
        "name": "notes",
        "value": "Testing for update the notes",
        "valueType": "string",
        "@type": "StringCharacteristic"
      },
      {
        "name": "registrationCode",
        "value": "111122112211",
        "valueType": "string",
        "@type": "StringCharacteristic"
      },
      {
        "name": "accountCode",
        "value": "accountcode1",
        "valueType": "string",
        "@type": "StringCharacteristic"
      },
      {
        "name": "identificationNumber",
        "value": "",
        "valueType": "string",
        "@type": "StringCharacteristic"
      },
      {
        "name": "taxId",
        "value": "CTNUM1000123",
        "valueType": "string",
        "@type": "StringCharacteristic"
      },
      {
        "name": "industry",
        "value": "technology_services",
        "valueType": "choice",
        "@type": "StringCharacteristic"
      },
      {
        "name": "numEmployees",
        "value": "",
        "valueType": "integer",
        "@type": "IntergerCharacteristic"
      },
      {
        "name": "rankTier",
        "value": "rankTier",
        "valueType": "string",
        "@type": "StringCharacteristic"
      },
      {
        "name": "publiclyTraded",
        "value": "false",
        "valueType": "boolean",
        "@type": "BooleanCharacteristic"
      },
      {
        "name": "stockSymbol",
        "value": "Market",
        "valueType": "string",
        "@type": "StringCharacteristic"
      },
      {
        "name": "stockPrice",
        "value": "1000",
        "valueType": "string",
        "@type": "StringCharacteristic"
      },
      {
        "name": "vendorType",
        "value": "Hardware",
        "valueType": "list",
        "@type": "StringArrayCharacteristic"
      },
      {
        "name": "marketCap",
        "value": "0",
        "valueType": "string",
        "@type": "StringCharacteristic"
      },
      {
        "name": "profits",
        "value": "0",
        "valueType": "string",
        "@type": "StringCharacteristic"
      },
      {
        "name": "revenuePerYear",
        "value": "0",
        "valueType": "string",
        "@type": "StringCharacteristic"
      },
      {
        "name": "website",
        "value": "",
        "valueType": "string",
        "@type": "StringCharacteristic"
      }
    ],
    "relatedParty": [],
    "organizationChildRelationship": [
      {
        "relationshipType": "Partner Account",
        "organization": {
          "id": "396b47201841a610f87765359bc696cf",
          "name": "child",
          "href": "api/sn_tmf_api/party/organization396b47201841a610f87765359bc696cf",
          "@type": "Organization"
        }
      }
    ],
    "organizationParentRelationship": {
      "relationshipType": "parent",
      "organization": {
        "id": "9e2fd2ee11b43110f877366201dea674",
        "name": "Startech svcs",
        "href": "api/sn_tmf_api/party/organization9e2fd2ee11b43110f877366201dea674",
        "@type": "Organization"
      }
    },
    "@type": "Organization",
    "partyOrPartyRole": {
      "name": "customer_partner",
      "role": "Account",
      "@type": "Party"
    }
  }
]

Gestion des parties : PATCH/api/sn_tmf_api/v1/party/individual/{id}

Met à jour un enregistrement de partie individuel existant dans la table Consommateur [csm_consumer] ou Contact [customer_contact] sans remplacer l’intégralité de la ressource.

Format d'URL

URL versionnée : /api/sn_tmf_api/v1/party/individual

URL par défaut : /api/sn_tmf_api/v1/party/individual

Paramètres de demande pris en charge

Tableau 31. Paramètres de chemin d'accès
Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par exemple, `v1` ou `v2`. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison autre que la plus récente. Type de données : chaîne
id	Sys_id du consommateur ou du contact. Tables : Consommateur [csm_consumer] ou Contact [customer_contact] Type de données : chaîne

Tableau 32. Paramètres de requête
Nom	Description
Néant

Tableau 33. Paramètres de corps de demande (XML ou JSON)
Nom	Description
contactMedium	Liste des moyens de contacter la partie. Type de données : tableau d’objets `"contactMedium": [ { "@type": "String", "city": "String", "country": "String", "emailAddress": "String", "locationId": "String", "mediumType": "String", "phoneNumber": "String", "postCode": "String", "preferred": "Boolean", "stateOrProvince": "String", "street1": "String", "street2": "String" } ]`
contactMedium.@type	Type de partie qui contacte. Indique le type de schéma ou de sous-classe spécifique de l’objet. Valeurs possibles : BusinessPhoneContactMedium : numéro de téléphone professionnel EmailContactMedium : adresse e-mail FaxPhoneContactMedium : Numéro de fax GeographicAddressContactMedium : adresse physique (rue, ville, état, code postal) HomePhoneContactMedium : numéro de téléphone du domicile MobilePhoneContactMedium : Numéro de téléphone portable Type de données : chaîne
contactMedium.city	Ville de l’individu. Type de données : chaîne
contactMedium.country	Pays de la personne. Type de données : chaîne
contactMedium.emailAddress	Adresse e-mail du contact. Type de données : chaîne
contactMedium.locationId	Sys_id du lieu de la fête. Table : Emplacement [cmn_location] Type de données : chaîne
contactMedium.mediumType	Le type de milieu de contact. Indique l’attribut au niveau de l’entreprise qui spécifie le type de canal de contact utilisé. Valeurs possibles : e-mail téléphone professionnel Téléphone du domicile Téléphone mobile adresse postale Type de données : chaîne
contactMedium.numéroTéléphone	Numéro de téléphone de la personne. Type de données : chaîne
contactMedium.postCode	Code postal de la personne. Type de données : chaîne
contactMedium.preferred	Cette valeur est toujours fausse. Type de données : booléennes
contactMedium.stateOrProvince	Indique si l’emplacement se trouve dans un État ou une province. Valeurs possibles : État Province (en anglais) Type de données : chaîne
contactMedium.street1	Décrit la rue. Type de données : chaîne
contactMedium.street2	Description complémentaire de la rue. Type de données : chaîne
nom de famille	Nom de famille de la personne. Type de données : chaîne
sexe	Sexe de la personne. Type de données : chaîne
givenName	Prénom de la personne. Type de données : chaîne
href	Lien relatif à l’enregistrement de l’utilisateur, du consommateur ou du contact. Type de données : chaîne
deuxième prénom	Deuxième prénom de la personne. Type de données : chaîne
nom	Nom d’utilisateur de l’utilisateur ou de la personne à contacter. Type de données : chaîne
nationalité	Nationalité de la personne. Type de données : chaîne
partyCharacteristics	Liste des caractéristiques associées au parti. Type de données : tableau d’objets `"partyCharacteristics": [ { "@type": "String", "name": " String", "value": "String", "valueType": "String" } ]`
partyCharacteristics.@type	Lors de la sous-classe, ce paramètre définit le nom extensible de la sous-classe. Valeurs possibles : Caractéristique de chaîne Caractéristique du tableau de chaînes Caractéristique entière Caractéristique booléenne Type de données : chaîne
partyCharacteristics.name	Nom de la caractéristique de la partie. Type de données : chaîne
partyCharacteristics.valeur	Valeur de la caractéristique de la partie. Type de données : chaîne
partyCharacteristics.valueType	Type de données de la valeur de la caractéristique. Type de données : chaîne
partyOrPartyRole	Les rôles associés à cette partie sont définis où la partie est créée dans la table. Par exemple, `utilisateur`, `consommateur`, `contact client`. partyOrPartyRole Indique le type d’enregistrement récupéré dans l’opération. Si le sys_id fourni appartient à la table Consumer (Consommateur) [csm_consumer], il partyOrPartyRole.role est alors défini sur `Consumer (Consommateur`). De même, si le sys_id appartient à la table Contact [customer_contact], il partyOrPartyRole.role est défini sur `Contact`. Type de données : objet `"partyOrPartyRole": { "@type": "String", "role":"String" }`
partyOrPartyRole.@type	Cette valeur est toujours `Partie`. Type de données : chaîne
partyOrPartyRole.role	Type de rôle. Valeurs possibles : Consommateur Contact Type de données : chaîne
Fête connexe	Liste des parties et des rôles de parties associés à cette partie. Type de données : tableau d’objets `"relatedParty": [ { "role": "String", "partyOrPartyRole": {Object} } ]`
relatedParty.partyOrPartyRole.@type	Type de la partie liée. Valeur possible pour l’utilisateur : Organisation Individuel Type de données : chaîne
relatedParty.partyOrPartyRole.id	ID de l’entité liée dans le système de gestion des parties ou de gestion des rôles des parties. Valeur possible pour l’utilisateur : `Société` `Département` Valeur possible pour le client : `compte` Valeur possible pour le consommateur : `utilisateur` Type de données : chaîne
relatedParty.partyOrPartyRole.name	Nom de la partie liée. Type de données : chaîne
relatedParty.role	Rôle d’entreprise que la partie liée joue dans le contexte de l’entité actuelle. Valeurs possibles : Société (si la partie liée est l’utilisateur) Département (si la partie liée est l’utilisateur) Compte (si la partie liée est le client) Utilisateur (si la partie liée est un consommateur) Type de données : chaîne
statut	Marqueur qui indique l’état de la personne. Valeurs valides : actif : la personne a un statut actif. inactif : la personne n’a pas un état actif. Type de données : booléennes
Titre	Préfixe ou titre de la personne. Par exemple, `Dr.`, `M.`, `Mme`). Type de données : chaîne

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.

Tableau 34. En-têtes de demandes
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

Tableau 35. En-têtes de réponses
En-tête	Description
Néant

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.

Tableau 36. Codes d'état
Code d'état	Description
200	Réussi. La demande a été traitée avec succès.

Paramètres du corps de la réponse (JSON ou XML)


Nom	Description
contactMedium	Liste des moyens de contacter la partie. Type de données : tableau d’objets `"contactMedium": [ { "@type": "String", "city": "String", "country": "String", "emailAddress": "String", "locationId": "String", "mediumType": "String", "phoneNumber": "String", "postCode": "String", "preferred": "Boolean", "stateOrProvince": "String", "street1": "String", "street2": "String" } ]`
contactMedium.@type	Type de partie qui contacte. Indique le type de schéma ou de sous-classe spécifique de l’objet. Valeurs possibles : BusinessPhoneContactMedium : numéro de téléphone professionnel EmailContactMedium : adresse e-mail FaxPhoneContactMedium : Numéro de fax GeographicAddressContactMedium : adresse physique (rue, ville, état, code postal) HomePhoneContactMedium : numéro de téléphone du domicile MobilePhoneContactMedium : Numéro de téléphone portable Type de données : chaîne
contactMedium.city	Ville de l’individu. Type de données : chaîne
contactMedium.country	Pays de la personne. Type de données : chaîne
contactMedium.emailAddress	Adresse e-mail du contact. Type de données : chaîne
contactMedium.locationId	Sys_id du lieu de la fête. Table : Emplacement [cmn_location] Type de données : chaîne
contactMedium.mediumType	Le type de milieu de contact. Indique l’attribut au niveau de l’entreprise qui spécifie le type de canal de contact utilisé. Valeurs possibles : e-mail téléphone professionnel Téléphone du domicile Téléphone mobile adresse postale Type de données : chaîne
contactMedium.numéroTéléphone	Numéro de téléphone de la personne. Type de données : chaîne
contactMedium.postCode	Code postal de la personne. Type de données : chaîne
contactMedium.preferred	Cette valeur est toujours fausse. Type de données : booléennes
contactMedium.stateOrProvince	Indique si l’emplacement est d’un État ou d’une province. Valeurs possibles : État Province (en anglais) Type de données : chaîne
contactMedium.street1	Décrit la rue. Type de données : chaîne
contactMedium.street2	Description complémentaire de la rue. Type de données : chaîne
nom de famille	Nom de famille de la personne. Type de données : chaîne
sexe	Sexe de la personne. Type de données : chaîne
givenName	Prénom de la personne. Type de données : chaîne
href	Lien relatif à l’enregistrement de l’utilisateur, du consommateur ou du contact. Type de données : chaîne
id	Sys_id de l’enregistrement de l’utilisateur, du consommateur ou du contact à récupérer. Tables : Consommateur [csm_consumer] ou Contact [customer_contact] Type de données : chaîne
deuxième prénom	Deuxième prénom de la personne. Type de données : chaîne
nom	Nom d’utilisateur de l’utilisateur ou de la personne à contacter. Type de données : chaîne
nationalité	Nationalité de la personne. Type de données : chaîne
partyCharacteristics	Liste des caractéristiques associées au parti. Type de données : tableau d’objets `"partyCharacteristics": [ { "@type": "String", "name": " String", "value": "String", "valueType": "String" } ]`
partyCharacteristics.@type	Lors de la sous-classe, cela définit le nom extensible de la sous-classe. Valeurs possibles : Caractéristique de chaîne Caractéristique du tableau de chaînes Caractéristique entière Caractéristique booléenne Type de données : chaîne
partyCharacteristics.name	Nom de la caractéristique de la partie. Type de données : chaîne
partyCharacteristics.valeur	Valeur de la caractéristique de la partie. Type de données : chaîne
partyCharacteristics.valueType	Type de données de la valeur de la caractéristique. Type de données : chaîne
partyOrPartyRole	Les rôles associés à cette partie sont définis où la partie est créée dans la table. Par exemple, `utilisateur`, `consommateur`, `contact client`. partyOrPartyRole Indique le type d’enregistrement récupéré dans l’opération. Si le sys_id fourni appartient à la table Consumer (Consommateur) [csm_consumer], il partyOrPartyRole.role est alors défini sur `Consumer (Consommateur`). De même, si le sys_id appartient à la table Contact [customer_contact], il partyOrPartyRole.role est défini sur `Contact`. Type de données : objet `"partyOrPartyRole": { "@type": "String", "role":"String" }`
partyOrPartyRole.@type	Cette valeur est toujours `Partie`. Type de données : chaîne
partyOrPartyRole.role	Type de rôle de la partie. Valeurs possibles : Consommateur Contact Type de données : chaîne
Fête connexe	Liste des parties ou des rôles de partie associés à cette partie. Type de données : tableau d’objets `"relatedParty": [ { "role": "String", "partyOrPartyRole": {Object} } ]`
relatedParty.partyOrPartyRole	Représente des informations sur la partie liée et le rôle qu’elle joue dans le contexte de l’enregistrement. Par exemple, si le rôle est `Société`, il partyOrPartyRole.id contient le sys_id de l’enregistrement Société [core_company] et partyOrPartyRole.name le nom de la société. Cette structure garantit que la référence au parti et son rôle sont explicitement définis et facilement identifiables. Type de données : objet `"partyOrPartyRole": { "@type": "String", "id": "String", "name": "String" }`
relatedParty.partyOrPartyRole.@type	Type de la partie liée. Valeur possible pour l’utilisateur : Organisation Individuel Type de données : chaîne
relatedParty.partyOrPartyRole.id	Sys_id de la partie liée. Valeur possible pour `l’utilisateur` : Société Département Valeur possible pour `le client` : compte Valeur possible pour `le consommateur` : utilisateur Type de données : chaîne
relatedParty.partyOrPartyRole.name	Nom de la partie liée. Type de données : chaîne
relatedParty.role	Rôle d’entreprise que la partie liée joue dans le contexte de l’entité actuelle. Valeurs possibles : Société (si la partie liée est l’utilisateur) Département (si la partie liée est l’utilisateur) Compte (si la partie liée est le client) Utilisateur (si la partie liée est un consommateur) Type de données : chaîne
statut	Marqueur qui indique l’état de la personne. Valeurs valides : actif : la personne a un statut actif. inactif : la personne est dans un état inactif. Type de données : booléennes
Titre	Préfixe ou titre de la personne. Par exemple, `Dr.`, `M.`, `Mme`). Type de données : chaîne

Demande cURL

Met à jour un enregistrement de partie individuel existant avec sys_id, 12345, dans la table Consommateur [csm_consumer] ou Contact [customer_contact] sans remplacer l’intégralité de la ressource.

curl "http://localhost:8080/api/sn_tmf_api/v1/party/Individual/12345" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--user 'user':'password'
--data "{
  \"name\": \"John.Doe\",
  \"givenName\": \"John\",
  \"middleName\": \"A.\",
  \"familyName\": \"Doe\",
  \"gender\": \"male\",
  \"nationality\": \"American\",
  \"title\": \"Mr\",
  \"contactMedium\": [
    {
      \"preferred\": true,
      \"mediumType\": \"email\",
      \"emailAddress\": \"john.doe@gmail.com\",
      \"@type\": \"EmailContactMedium\"
    },
    {
      \"preferred\": false,
      \"mediumType\": \"businessPhone\",
      \"phoneNumber\": \"+1-202-555-0188\",
      \"@type\": \"PhoneContactMedium\"
    },
    {
      \"preferred\": false,
      \"mediumType\": \"homePhone\",
      \"phoneNumber\": \"+1-202-555-0198\",
      \"@type\": \"HomePhoneContactMedium\"
    },
    {
      \"preferred\": false,
      \"mediumType\": \"postalAddress\",
      \"@type\": \"GeographicAddressContactMedium\",
      \"locationId\":\"92656927259338967\",
      \"city\": \"Morristown\",
      \"country\": \"USA\",
      \"postCode\": \"07960\",
      \"stateOrProvince\": \"New Jersey\",
      \"street1\": \"240 Headquarters Plazza\", 
      \"street2\": \"East Tower - 10th Floor\"
    }
  ],
  \"partyCharacteristic\": [
    {
        \"name\": \"notification\",
        \"value\": \"enable\",
        \"valueType\": \"string\",
        \"@type\": \"string\"
    },
    {
        \"name\": \"dateFormat\",
        \"value\": \"MM/DD/YYYY\",
        \"valueType\": \"string\",
        \"@type\": \"string\"
    },
    {
        \"name\": \"timeFormat\",
        \"value\": \"12-hour\",
        \"valueType\": \"string\",
        \"@type\": \"string\"
    },
    {
        \"name\": \"timeZone\",
        \"value\": \"EST\",
        \"valueType\": \"string\",
        \"@type\": \"string\"
    },
    {
        \"name\": \"vip\",
        \"value\": true,
        \"valueType\": \"boolean\",
        \"@type\": \"string\"
    },
    {
        \"name\": \"webServiceAccessOnly\",
        \"value\": false,
        \"valueType\": \"boolean\",
        \"@type\": \"string\"
    },
    {
        \"name\": \"source\",
        \"value\": \"Third-party system\",
        \"valueType\": \"string\",
        \"@type\": \"string\"
    },
    {
        \"name\": \"eduStatus\",
        \"value\": \"Graduated\",
        \"valueType\": \"string\",
        \"@type\": \"string\"
    }
  ],
  \"relatedParty\": [
    {
      \"role\": \"Company\",
      \"partyOrPartyRole\": {
        \"id\": \"86c1f3193790200044e0bfc8bcbe5d95\",
        \"name\": \"Acme Corporation\",
        \"@type\": \"Organization\"
      }
    },
    {
      \"role\": \"Department\",
      \"partyOrPartyRole\": {
        \"id\": \"c3fdd27a7b9822105e0d5494548cb6b0\",
        \"name\": \"Acme Corporation\",
        \"@type\": \"Organization\"
      }
    }
  ],
  \"status\": \"active\",
  \"@type\": \"Individual\",
  \"partyOrPartyRole\": {
    \"role\": \"Consumer\",
    \"@type\":\"Party\"
  }
}" \

Corps de la réponse.

{
   "name": "Jane Smith",
  "givenName": "Jane",
  "middleName": "B.",
  "familyName": "Smith",
  "gender": "female",
  "nationality": "American",
  "title": "Ms",
  "contactMedium": [
    {
      "preferred": true,
      "mediumType": "email",
      "emailAddress": "jane.smith@example.com",
      "@type": "EmailContactMedium"
    },
    {
      "preferred": false,
      "mediumType": "mobilePhone",
      "phoneNumber": "+1-416-555-1234",
      "@type": "PhoneContactMedium"
    },
    {
      "preferred": false,
      "mediumType": "businessPhone",
      "phoneNumber": "+1-416-555-5678",
      "@type": "BusinessPhoneContactMedium"
    },
    {
      "preferred": false,
      "mediumType": "fax",
      "fax": "987654321",
      "@type": "FaxContactMedium"
    },
    {
      "preferred": false,
      "mediumType": "homePhone",
      "phoneNumber": "+1-416-555-4321",
      "@type": "HomePhoneContactMedium"
    },
    {
      "preferred": false,
      "mediumType": "postalAddress",
      "@type": "GeographicAddressContactMedium",
      "locationId": "03e588a17be062105e0d5494548cb68c",
      "city": "Toronto",
      "country": "Canada",
      "postCode": "M5H 2N2",
      "stateOrProvince": "Ontario",
      "street1": "123 Queen St W",
      "street2": "Suite 1500"
    }
  ],
  "externalReference": [
    {
      "externalIdentifierType": "linkedin",
      "id": "http://linkedin.com/in/janesmith"
    }
  ],
  "partyCharacteristic": [
    {
      "name": "notes",
      "value": "General consumer information.",
      "valueType": "string",
      "@type": "string"
    },
    {
      "name": "userName",
      "value": "janesmith",
      "valueType": "string",
      "@type": "string"
    },
    {
      "name": "vip",
      "value": false,
      "valueType": "boolean",
      "@type": "string"
    },
    {
      "name": "source",
      "value": "CRM System",
      "valueType": "string",
      "@type": "string"
    },
    {
      "name": "dateFormat",
      "value": "yyyy-mm-dd",
      "valueType": "string",
      "@type": "string"
    },
    {
      "name": "timeformat",
      "value": "HH:mm:ss (24 hour)",
      "valueType": "string",
      "@type": "string"
    },
    {
      "name": "notification",
      "value": "Disabled",
      "valueType": "string",
      "@type": "string"
    }
  ],
  "relatedParty": [
    {
      "role": "User",
      "partyOrPartyRole": {
        "id": "c456def03710200044e0bfc8bcbe5d99",
        "name": "Global Corp",
        "@type": "Individual"
      }
    }
  ],
  "status": "active",
  "@type": "Individual",
  "partyOrPartyRole": {
    "role": "Consumer",
    "@type": "Party"
  },
   "warning": [
    "relatedParty[0] is incorrect. User does not exist"
  ]
}

Gestion des parties : PATCH /api/sn_tmf_api/v1/party/organization/{id}

Met à jour un enregistrement de partie individuel existant dans les tables Compte [customer_account] sans remplacer la ressource entière.

Format d'URL

URL versionnée : /api/sn_tmf_api/v1/party/organization/{id}

URL par défaut : /api/sn_tmf_api/v1/party/organization/{id}

Paramètres de demande pris en charge

Tableau 37. Paramètres de chemin d'accès
Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par exemple, `v1` ou `v2`. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison autre que la plus récente. Type de données : chaîne

Tableau 38. Paramètres de requête
Nom	Description
Néant

Tableau 39. Paramètres de corps de demande (XML ou JSON)
Nom	Description
@type	Cette valeur est toujours `Organisation`. Type de données : chaîne
contactMedium	Liste des moyens de contacter la partie. Un moyen de contact représente la façon dont vous communiquez ou atteignez une partie comme une personne ou une organisation. Par exemple, un canal ou une méthode de contact associé à cette partie. Type de données : tableau d’objets `"contactMedium": [ { "@type": "String", "city": "String", "country": "String", "emailAddress": "String", "locationId": "String", "mediumType": "String", "phoneNumber": "String", "postCode": "String", "preferred": "Boolean", "stateOrProvince": "String", "street1": "String", "street2": "String" } ]`
contactMedium.@type	Type de support de contact. Type de partie qui contacte. Indique le type de schéma ou de sous-classe spécifique de l’objet. Valeurs possibles : BusinessPhoneContactMedium : numéro de téléphone professionnel EmailContactMedium : adresse e-mail FaxPhoneContactMedium : Numéro de fax GeographicAddressContactMedium : adresse physique (rue, ville, état, code postal) HomePhoneContactMedium : numéro de téléphone du domicile MobilePhoneContactMedium : Numéro de téléphone portable Type de données : chaîne
contactMedium.city	Ville de l’organisation. Type de données : chaîne
contactMedium.country	Pays de l’organisation. Type de données : chaîne
contactMedium.emailAdress	Adresse e-mail du contact de l’organisation. Type de données : chaîne
contactMedium.locationId	Sys_id de l’emplacement. Table : Emplacement [cmn_location] Type de données : chaîne
contactMedium.mediumType	Le type de milieu de contact. Valeurs possibles : téléphone professionnel e-mail faxPhone Téléphone du domicile Téléphone mobile adresse postale Type de données : chaîne
contactMedium.numéroTéléphone	Numéro de téléphone du contact de l’organisation. Type de données : chaîne
contactMedium.postCode	Code postal de l’organisation. Type de données : chaîne
contactMedium.preferred	Cette valeur est toujours `fausse`. Type de données : booléennes
contactMedium.stateOrProvince	Indique si l’emplacement est d’un État ou d’une province. Valeurs possibles : État Province (en anglais) Type de données : chaîne
contactMedium.street1	Décrit la rue. Type de données : chaîne
contactMedium.street2	Description complémentaire de la rue. Type de données : chaîne
Référence externe	Liste des identificateurs de la partie dans un système externe. Type de données : tableau d’objets `"externalReference": [ { "externalIdentifierType": "String", "name": "String" } ]`
Référenceexterne.TypeIdentificateur externe	Type d’entité au sein du système externe. Type de données : chaîne
externalReference.name	Nom explicite du système externe ou de la référence. Type de données : chaîne
href	Lien relatif à l’enregistrement de compte (URI). Table : Compte [customer_account] Type de données : chaîne
id	Sys_id de l’enregistrement du compte d’entité externe. Table : Compte [customer_account] Type de données : chaîne
nom légal	Nom juridique de l’organisation. Type de données : chaîne
nom	Nom de l’organisation. Type de données : chaîne
partyCharacteristics	Liste des caractéristiques qu’un groupe peut adopter. Type de données : tableau d’objets `"partyCharacteristics": [ { "@type": "String" "name": "String", "value": "String", "valueType": "String" } ]`
partyCharacteristics.@type	Lors de la sous-classe, @type définit le nom extensible de la sous-classe. Valeur possible : Caractéristique booléenne Caractéristique entière Caractéristique du tableau de chaînes Caractéristique de chaîne Type de données : chaîne
partyCharacteristics.name	Nom de la caractéristique de la partie. Type de données : chaîne
partyCharacteristics.valeur	Valeur de la caractéristique de la partie. Type de données : chaîne
partyCharacteristics.valueType	Type de données de la valeur de la caractéristique. Type de données : chaîne
partyOrPartyRole	Les rôles associés à cette partie sont définis à l’endroit où la partie est créée dans la table. Par exemple, `Société` ou `Compte`. partyOrPartyRole Indique le type d’enregistrement récupéré dans l’opération. Si le sys_id fourni appartient à la table Compte [customer_account], alors partyOrPartyRole.role il est défini sur `Compte`. De même, si le sys_id appartient à la table Société [core_company], il partyOrPartyRole.role est défini sur `Société`. Type de données : objet `"partyOrPartyRole": { "@type": "String", "name":"String", "role":"String", }`
PartyOrPartyRole.@type	Cette valeur est toujours `fête`. Type de données : chaîne
PartyOrPartyRole.name	Définit le type de compte ou de société. Type de données : chaîne
PartyOrPartyRole.role	Type de rôle. Valeur possible : Compte Société Type de données : chaîne
Fête connexe	Liste des parties ou des rôles de partie associés à cette partie. Type de données : tableau d’objets `"relatedParty": [ { "partyOrPartyRole": {Object}, "role": "String" } ]`
relatedParty.partyOrPartyRole	Rôles associés à cette partie. Type de données : tableau d’objets `"partyOrPartyRole": [ { "@type": "String", "id": "String", "name": "String", } ]`
relatedParty.partyOrPartyRole.@type	Type de la partie liée. La valeur est toujours `Organisation`. Type de données : chaîne
relatedParty.partyOrPartyRole.id	Sys_id de la partie liée. Valeur possible : Contact Autre Type de données : chaîne
relatedParty.partyOrPartyRole.name	Nom de la partie liée. Type de données : chaîne
relatedParty.role	Rôle joué par la partie liée ou le rôle de partie dans le contexte de l’entité spécifique à laquelle il est lié. Valeurs possibles : Contact Autre Type de données : chaîne
statut	Marqueur qui indique l’état de l’organisation. Valeurs valides : actif : l’organisation est active. inactif : l’organisation est inactive. Type de données : booléennes
Nom du trading	Nom sous lequel l’organisation exerce ses activités. Type de données : chaîne

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.

Tableau 40. En-têtes de demandes
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

Tableau 41. En-têtes de réponses
En-tête	Description
Néant

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.

Tableau 42. Codes d'état
Code d'état	Description
200	Réussi. La demande a été traitée avec succès.

Paramètres du corps de la réponse (JSON ou XML)


Nom	Description
@type	Cette valeur est toujours `Organisation`. Type de données : chaîne
contactMedium	Liste des moyens de contacter la partie. Un moyen de contact représente la façon dont vous communiquez ou atteignez une partie comme une personne ou une organisation. Par exemple, un canal ou une méthode de contact associé à cette partie. Type de données : tableau d’objets `"contactMedium": [ { "@type": "String", "city": "String", "country": "String", "emailAddress": "String", "locationId": "String", "mediumType": "String", "phoneNumber": "String", "postCode": "String", "preferred": "Boolean", "stateOrProvince": "String", "street1": "String", "street2": "String" } ]`
contactMedium.@type	Type de support de contact. Type de partie qui contacte. Indique le type de schéma ou de sous-classe spécifique de l’objet. Valeurs possibles : BusinessPhoneContactMedium : numéro de téléphone professionnel EmailContactMedium : adresse e-mail FaxPhoneContactMedium : Numéro de fax GeographicAddressContactMedium : adresse physique (rue, ville, état, code postal) HomePhoneContactMedium : numéro de téléphone du domicile MobilePhoneContactMedium : Numéro de téléphone portable Type de données : chaîne
contactMedium.city	Ville de l’organisation. Type de données : chaîne
contactMedium.country	Pays de l’organisation. Type de données : chaîne
contactMedium.emailAdress	Adresse e-mail du contact de l’organisation. Type de données : chaîne
contactMedium.locationId	Sys_id de l’emplacement. Table : Emplacement [cmn_location] Type de données : chaîne
contactMedium.mediumType	Le type de milieu de contact. Valeurs possibles : téléphone professionnel e-mail faxPhone Téléphone du domicile Téléphone mobile adresse postale Type de données : chaîne
contactMedium.numéroTéléphone	Numéro de téléphone du contact de l’organisation. Type de données : chaîne
contactMedium.postCode	Code postal de l’organisation. Type de données : chaîne
contactMedium.preferred	Cette valeur est toujours `fausse`. Type de données : booléennes
contactMedium.stateOrProvince	Indique si l’emplacement est d’un État ou d’une province. Valeurs possibles : État Province (en anglais) Type de données : chaîne
contactMedium.street1	Décrit la rue. Type de données : chaîne
contactMedium.street2	Description complémentaire de la rue. Type de données : chaîne
Référence externe	Liste des identificateurs de la partie dans un système externe. Type de données : tableau d’objets `"externalReference": [ { "externalIdentifierType": "String", "name": "String" } ]`
Référenceexterne.TypeIdentificateur externe	Type d’entité au sein du système externe. Type de données : chaîne
externalReference.name	Nom explicite du système externe ou de la référence. Type de données : chaîne
href	Lien relatif à l’enregistrement de compte (URI). Table : Compte [customer_account] Type de données : chaîne
id	Sys_id de l’enregistrement du compte d’entité externe. Table : Compte [customer_account] Type de données : chaîne
nom légal	Nom juridique de l’organisation. Type de données : chaîne
nom	Nom de l’organisation. Type de données : chaîne
partyCharacteristics	Liste des caractéristiques qu’un groupe peut adopter. Type de données : tableau d’objets `"partyCharacteristics": [ { "@type": "String" "name": "String", "value": "String", "valueType": "String" } ]`
partyCharacteristics.@type	Lors de la sous-classe, @type définit le nom extensible de la sous-classe. Valeur possible : Caractéristique booléenne Caractéristique entière Caractéristique du tableau de chaînes Caractéristique de chaîne Type de données : chaîne
partyCharacteristics.name	Nom de la caractéristique de la partie. Type de données : chaîne
partyCharacteristics.valeur	Valeur de la caractéristique de la partie. Type de données : chaîne
partyCharacteristics.valueType	Type de données de la valeur de la caractéristique. Type de données : chaîne
partyOrPartyRole	Les rôles associés à cette partie sont définis à l’endroit où la partie est créée dans la table. Par exemple, `Société` ou `Compte`. partyOrPartyRole Indique le type d’enregistrement récupéré dans l’opération. Si le sys_id fourni appartient à la table Compte [customer_account], alors partyOrPartyRole.role il est défini sur `Compte`. De même, si le sys_id appartient à la table Société [core_company], il partyOrPartyRole.role est défini sur `Société`. Type de données : objet `"partyOrPartyRole": { "@type": "String", "name":"String", "role":"String", }`
PartyOrPartyRole.@type	Cette valeur est toujours `fête`. Type de données : chaîne
PartyOrPartyRole.name	Définit le type de compte ou de société. Type de données : chaîne
PartyOrPartyRole.role	Type de rôle. Valeur possible : Compte Société Type de données : chaîne
Fête connexe	Liste des parties ou des rôles de partie associés à cette partie. Type de données : tableau d’objets `"relatedParty": [ { "partyOrPartyRole": {Object}, "role": "String" } ]`
relatedParty.partyOrPartyRole	Rôles associés à cette partie. Type de données : tableau d’objets `"partyOrPartyRole": [ { "@type": "String", "id": "String", "name": "String", } ]`
relatedParty.partyOrPartyRole.@type	Type de la partie liée. La valeur est toujours `Organisation`. Type de données : chaîne
relatedParty.partyOrPartyRole.id	Sys_id de la partie liée. Valeur possible : Contact Autre Type de données : chaîne
relatedParty.partyOrPartyRole.name	Nom de la partie liée. Type de données : chaîne
relatedParty.role	Rôle joué par la partie liée ou le rôle de partie dans le contexte de l’entité spécifique à laquelle il est lié. Valeurs possibles : Contact Autre Type de données : chaîne
statut	Marqueur qui indique l’état de l’organisation. Valeurs valides : actif : l’organisation est active. inactif : l’organisation est inactive. Type de données : booléennes
Nom du trading	Nom sous lequel l’organisation exerce ses activités. Type de données : chaîne

Demande cURL

Renvoie les champs spécifiés pour les enregistrements de l’organisation de gestion des parties.

curl "http://instance.service-now.com/api/sn_tmf_api/v1/party/organization" \
--request PATCH\
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--user 'user':'password' \
--data "{
  \"name\": \"SERVICENOW 144\",
  \"legalName\": \"Acme Corp Ltd.\",
  \"tradingName\": \"Acme Inc.\",
  \"contactMedium\": [
    {
      \"preferred\": true,
      \"mediumType\": \"email\",
      \"emailAddress\": \"athammhd@email.com\",
      \"@type\": \"EmailContactMedium\"
    },
    {
      \"preferred\": false,
      \"mediumType\": \"phone\",
      \"phoneNumber\": \"+1-202-555-0198\",
      \"@type\": \"PhoneContactMedium\"
    },
    {
      \"preferred\": false,
      \"mediumType\": \"businessPhone\",
      \"phoneNumber\": \"+1-202-555-0198\",
      \"@type\": \"BusinessPhoneContactMedium\"
    },
    {
      \"preferred\": false,
      \"mediumType\": \"homePhone\",
      \"phoneNumber\": \"+1-202-555-0198\",
      \"@type\": \"HomePhoneContactMedium\"
    },
    {
      \"preferred\": false,
      \"mediumType\": \"postalAddress\",
      \"validFor\": {
        \"startDateTime\": \"2017-03-15T07:49:25.246Z\"
      },
      \"@type\": \"GeographicAddressContactMedium\",
      \"city\": \"chennai\",
      \"country\": \"INDIA\",
      \"postCode\": \"608001\",
      \"stateOrProvince\": \"tamil nadu\",
      \"street1\": \"samcon street\",
      \"street2\": \"adyar,chennai\"
    }
  ],
  \"externalReference\": [
    {
      \"externalIdentifierType\": \"Instagram\",
      \"id\": \"Instagram\"
    }
  ],
  \"partyCharacteristic\": [
    {
      \"name\": \"notes\",
      \"value\": \"Testing for update the notes\",
      \"valueType\": \"string\",
      \"@type\": \"StringCharacteristics\"
    },
    {
      \"name\": \"customer\",
      \"value\": \"true\",
      \"valueType\": \"boolean\",
       \"@type\": \"StringCharacteristics\"
    },
    {
      \"name\": \"registrationCode\",
      \"value\": \"001\",
      \"valueType\": \"string\",
       \"@type\": \"StringCharacteristics\"
    },
    {
     \"name\": \"vendorType\",
     \"value\": [\"Hardware\"],
     \"valueType\": \"array\",
      \"@type\": \"StringArrayCharacteristic\"
     },
     {
      \"name\": \"industry\",
      \"value\": \"technology_services\",
      \"valueType\": \"choice\",
        \"@type\": \"StringCharacteristics\"
    },
    {
      \"name\": \"taxId\",
      \"value\": \"CTNUM1000123\",
      \"valueType\": \"string\",
       \"@type\": \"StringCharacteristics\"
    },
    {
      \"name\": \"numEmployees\",
      \"value\": \"EMP1000\",
      \"valueType\": \"integer\",
       \"@type\": \"StringCharacteristics\"
    },
    {
      \"name\": \"rankTier\",
      \"value\": \"rankTier\",
      \"valueType\": \"string\",
       \"@type\": \"StringCharacteristics\"
    },
    {
      \"name\": \"publiclyTraded\",
      \"value\": \"false\",
      \"valueType\": \"boolean\",
       \"@type\": \"StringCharacteristics\"
    },
    {
      \"name\": \"stockSymbol\",
      \"value\": \"Market\",
      \"valueType\": \"string\",
       \"@type\": \"StringCharacteristics\"
    },
    {
      \"name\": \"stockPrice\",
      \"value\": \"1000\",
      \"valueType\": \"string\",
       \"@type\": \"StringCharacteristics\"
    },
    {
      \"name\": \"vendor\",
      \"value\": \"false\",
      \"valueType\": \"boolean\",
       \"@type\": \"StringCharacteristics\"
    },
    {
      \"name\": \"manufacturer\",
      \"value\": \"false\",
      \"valueType\": \"boolean\",
       \"@type\": \"StringCharacteristics\"
    },
    {
      \"name\": \"marketCap\",
      \"value\": \"0\",
      \"valueType\": \"currency\",
       \"@type\": \"StringCharacteristics\"
    },
    {
      \"name\": \"profits\",
      \"value\": \"0\",
      \"valueType\": \"currency\",
       \"@type\": \"StringCharacteristics\"
    },
    {
      \"name\": \"revenuePerYear\",
      \"value\": \"0\",
      \"valueType\": \"currency\",
       \"@type\": \"StringCharacteristics\"
    }
  ],
  \"relatedParty\": [
    {
      \"role\": \"primaryContact\",
      \"partyOrPartyRole\": {
        \"id\": \"eaf68911c35420105252716b7d40ddde\",
        \"name\": \"John Doe\",
        \"@type\": \"Individual\"
      }
    },
    {
      \"role\": \"other\",
      \"partyOrPartyRole\": {
        \"id\": \"776a22ea11f43110f877366201dea6b7\",
        \"name\": \"Mary Star\",
        \"@type\": \"Individual\"
      }
    }
  ],
  \"organizationChildRelationship\": [
    {
      \"relationshipType\": \"partneraccount\",
      \"organization\": {
        \"id\": \"0fef075b2fe06a10b79db3bf42faf31a\",
        \"name\": \"mhd\",
        \"@type\": \"Organization\"
      }
    }
  ],
  \"organizationParentRelationship\": 
    {
      \"relationshipType\": \"Account\",
      \"organization\": {
        \"id\": \"9e2fd2ee11b43110f877366201dea674\",
        \"name\": \"Global Holdings Ltd.\",
        \"@type\": \"Organization\"
      }
    },
  \"status\": \"active\",
  \"@type\": \"Organization\",
  \"partyOrPartyRole\": {
    \"@type\":\"Party\",
    \"name\":\"Customer\",
    \"role\": \"Account\" 
  }
}" \

Corps de la réponse.

{
  "name": "SERVICENOW 144",
  "legalName": "Acme Corp Ltd.",
  "tradingName": "Acme Inc.",
  "contactMedium": [
    {
      "preferred": true,
      "mediumType": "email",
      "emailAddress": "athammhd@email.com",
      "@type": "EmailContactMedium"
    },
    {
      "preferred": false,
      "mediumType": "phone",
      "phoneNumber": "+1-202-555-0198",
      "@type": "PhoneContactMedium"
    },
    {
      "preferred": false,
      "mediumType": "businessPhone",
      "phoneNumber": "+1-202-555-0198",
      "@type": "BusinessPhoneContactMedium"
    },
    {
      "preferred": false,
      "mediumType": "homePhone",
      "phoneNumber": "+1-202-555-0198",
      "@type": "HomePhoneContactMedium"
    },
    {
      "preferred": false,
      "mediumType": "postalAddress",
      "validFor": {
        "startDateTime": "2017-03-15T07:49:25.246Z"
      },
      "@type": "GeographicAddressContactMedium",
      "city": "chennai",
      "country": "INDIA",
      "postCode": "608001",
      "stateOrProvince": "tamil nadu",
      "street1": "samcon street",
      "street2": "adyar,chennai"
    }
  ],
  "externalReference": [
    {
      "externalIdentifierType": "Instagram",
      "id": "Instagram"
    }
  ],
  "partyCharacteristic": [
    {
      "name": "notes",
      "value": "Testing for update the notes",
      "valueType": "string",
      "@type": "StringCharacteristics"
    },
    {
      "name": "customer",
      "value": "true",
      "valueType": "boolean",
       "@type": "StringCharacteristics"
    },
    {
      "name": "registrationCode",
      "value": "001",
      "valueType": "string",
       "@type": "StringCharacteristics"
    },
    {
     "name": "vendorType",
     "value": ["Hardware"],
     "valueType": "array",
      "@type": "StringArrayCharacteristic"
     },
     {
      "name": "industry",
      "value": "technology_services",
      "valueType": "choice",
        "@type": "StringCharacteristics"
    },
    {
      "name": "taxId",
      "value": "CTNUM1000123",
      "valueType": "string",
       "@type": "StringCharacteristics"
    },
    {
      "name": "numEmployees",
      "value": "EMP1000",
      "valueType": "integer",
       "@type": "StringCharacteristics"
    },
    {
      "name": "rankTier",
      "value": "rankTier",
      "valueType": "string",
       "@type": "StringCharacteristics"
    },
    {
      "name": "publiclyTraded",
      "value": "false",
      "valueType": "boolean",
       "@type": "StringCharacteristics"
    },
    {
      "name": "stockSymbol",
      "value": "Market",
      "valueType": "string",
       "@type": "StringCharacteristics"
    },
    {
      "name": "stockPrice",
      "value": "1000",
      "valueType": "string",
       "@type": "StringCharacteristics"
    },
    {
      "name": "vendor",
      "value": "false",
      "valueType": "boolean",
       "@type": "StringCharacteristics"
    },
    {
      "name": "manufacturer",
      "value": "false",
      "valueType": "boolean",
       "@type": "StringCharacteristics"
    },
    {
      "name": "marketCap",
      "value": "0",
      "valueType": "currency",
       "@type": "StringCharacteristics"
    },
    {
      "name": "profits",
      "value": "0",
      "valueType": "currency",
       "@type": "StringCharacteristics"
    },
    {
      "name": "revenuePerYear",
      "value": "0",
      "valueType": "currency",
       "@type": "StringCharacteristics"
    }
  ],
  "relatedParty": [
    {
      "role": "primaryContact",
      "partyOrPartyRole": {
        "id": "eaf68911c35420105252716b7d40ddde",
        "name": "John Doe",
        "@type": "Individual"
      }
    },
    {
      "role": "other",
      "partyOrPartyRole": {
        "id": "776a22ea11f43110f877366201dea6b7",
        "name": "Mary Star",
        "@type": "Individual"
      }
    }
  ],
  "organizationChildRelationship": [
    {
      "relationshipType": "partneraccount",
      "organization": {
        "id": "0fef075b2fe06a10b79db3bf42faf31a",
        "name": "mhd",
        "@type": "Organization"
      }
    }
  ],
  "organizationParentRelationship": 
    {
      "relationshipType": "Account",
      "organization": {
        "id": "9e2fd2ee11b43110f877366201dea674",
        "name": "Global Holdings Ltd.",
        "@type": "Organization"
      }
    },
  "status": "active",
  "@type": "Organization",
  "partyOrPartyRole": {
    "@type":"Party",
    "name":"Customer",
    "role": "Account" 
  }
}

Gestion des parties : POST /api/sn_tmf_api/v1/party/individual

Crée un nouvel enregistrement de gestion des parties individuelles dans les tables Consommateur [csm_consumer] ou Contact [customer_contact].

Format d'URL

URL versionnée : /api/sn_tmf_api/v1/party/individual

URL par défaut : /api/sn_tmf_api/v1/party/individual

Paramètres de demande pris en charge

Tableau 43. Paramètres de chemin d'accès
Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par exemple, `v1` ou `v2`. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison autre que la plus récente. Type de données : chaîne

Tableau 44. Paramètres de requête
Nom	Description
Néant

Tableau 45. Paramètres de corps de demande (XML ou JSON)
Nom	Description
contactMedium	Liste des moyens de contacter la partie. Type de données : tableau d’objets `"contactMedium": [ { "@type": "String", "city": "String", "country": "String", "emailAddress": "String", "locationId": "String", "mediumType": "String", "phoneNumber": "String", "postCode": "String", "preferred": "Boolean", "stateOrProvince": "String", "street1": "String", "street2": "String" } ]`
contactMedium.@type	Type de partie qui contacte. Indique le type de schéma ou de sous-classe spécifique de l’objet. Valeurs possibles : BusinessPhoneContactMedium : numéro de téléphone professionnel EmailContactMedium : adresse e-mail FaxPhoneContactMedium : Numéro de fax GeographicAddressContactMedium : adresse physique (rue, ville, état, code postal) HomePhoneContactMedium : numéro de téléphone du domicile MobilePhoneContactMedium : Numéro de téléphone portable Type de données : chaîne
contactMedium.city	Ville de l’individu. Type de données : chaîne
contactMedium.country	Pays de la personne. Type de données : chaîne
contactMedium.emailAddress	Adresse e-mail du contact. Type de données : chaîne
contactMedium.locationId	Sys_id du lieu de la fête. Table : Emplacement [cmn_location] Type de données : chaîne
contactMedium.mediumType	Le type de milieu de contact. Indique l’attribut au niveau de l’entreprise qui spécifie le type de canal de contact utilisé. Valeurs possibles : e-mail téléphone professionnel Téléphone du domicile Téléphone mobile adresse postale Type de données : chaîne
contactMedium.numéroTéléphone	Numéro de téléphone de la personne. Type de données : chaîne
contactMedium.postCode	Code postal de la personne. Type de données : chaîne
contactMedium.preferred	Cette valeur est toujours fausse. Type de données : booléennes
contactMedium.stateOrProvince	Indique si l’emplacement se trouve dans un État ou une province. Valeurs possibles : État Province (en anglais) Type de données : chaîne
contactMedium.street1	Décrit la rue. Type de données : chaîne
contactMedium.street2	Description complémentaire de la rue. Type de données : chaîne
nom de famille	Nom de famille de la personne. Type de données : chaîne
sexe	Sexe de la personne. Type de données : chaîne
givenName	Prénom de la personne. Type de données : chaîne
href	Lien relatif à l’enregistrement de l’utilisateur, du consommateur ou du contact. Type de données : chaîne
deuxième prénom	Deuxième prénom de la personne. Type de données : chaîne
nom	Nom d’utilisateur de l’utilisateur ou de la personne à contacter. Type de données : chaîne
nationalité	Nationalité de la personne. Type de données : chaîne
partyCharacteristics	Liste des caractéristiques associées au parti. Type de données : tableau d’objets `"partyCharacteristics": [ { "@type": "String", "name": " String", "value": "String", "valueType": "String" } ]`
partyCharacteristics.@type	Lors de la sous-classe, ce paramètre définit le nom extensible de la sous-classe. Valeurs possibles : Caractéristique de chaîne Caractéristique du tableau de chaînes Caractéristique entière Caractéristique booléenne Type de données : chaîne
partyCharacteristics.name	Nom de la caractéristique de la partie. Type de données : chaîne
partyCharacteristics.valeur	Valeur de la caractéristique de la partie. Type de données : chaîne
partyCharacteristics.valueType	Type de données de la valeur de la caractéristique. Type de données : chaîne
partyOrPartyRole	Les rôles associés à cette partie sont définis où la partie est créée dans la table. Par exemple, `utilisateur`, `consommateur`, `contact client`. partyOrPartyRole Indique le type d’enregistrement récupéré dans l’opération. Si le sys_id fourni appartient à la table Consumer (Consommateur) [csm_consumer], il partyOrPartyRole.role est alors défini sur `Consumer (Consommateur`). De même, si le sys_id appartient à la table Contact [customer_contact], il partyOrPartyRole.role est défini sur `Contact`. Type de données : objet `"partyOrPartyRole": { "@type": "String", "role":"String" }`
partyOrPartyRole.@type	Cette valeur est toujours `Partie`. Type de données : chaîne
partyOrPartyRole.role	Type de rôle. Valeurs possibles : Consommateur Contact Type de données : chaîne
Fête connexe	Liste des parties et des rôles de parties associés à cette partie. Type de données : tableau d’objets `"relatedParty": [ { "role": "String", "partyOrPartyRole": {Object} } ]`
relatedParty.partyOrPartyRole.@type	Type de la partie liée. Valeur possible pour l’utilisateur : Organisation Individuel Type de données : chaîne
relatedParty.partyOrPartyRole.id	ID de l’entité liée dans le système de gestion des parties ou de gestion des rôles des parties. Valeur possible pour l’utilisateur : `Société` `Département` Valeur possible pour le client : `compte` Valeur possible pour le consommateur : `utilisateur` Type de données : chaîne
relatedParty.partyOrPartyRole.name	Nom de la partie liée. Type de données : chaîne
relatedParty.role	Rôle d’entreprise que la partie liée joue dans le contexte de l’entité actuelle. Valeurs possibles : Société (si la partie liée est l’utilisateur) Département (si la partie liée est l’utilisateur) Compte (si la partie liée est le client) Utilisateur (si la partie liée est un consommateur) Type de données : chaîne
statut	Marqueur qui indique l’état de la personne. Valeurs valides : actif : la personne a un statut actif. inactif : la personne n’a pas un état actif. Type de données : booléennes
Titre	Préfixe ou titre de la personne. Par exemple, `Dr.`, `M.`, `Mme`). Type de données : chaîne

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.

Tableau 46. En-têtes de demandes
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

Tableau 47. En-têtes de réponses
En-tête	Description
Néant

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.

Tableau 48. Codes d'état
Code d'état	Description
200	Réussi. La demande a été traitée avec succès.

Paramètres du corps de la réponse (JSON ou XML)


Nom	Description
contactMedium	Liste des moyens de contacter la partie. Type de données : tableau d’objets `"contactMedium": [ { "@type": "String", "city": "String", "country": "String", "emailAddress": "String", "locationId": "String", "mediumType": "String", "phoneNumber": "String", "postCode": "String", "preferred": "Boolean", "stateOrProvince": "String", "street1": "String", "street2": "String" } ]`
contactMedium.@type	Type de partie qui contacte. Indique le type de schéma ou de sous-classe spécifique de l’objet. Valeurs possibles : BusinessPhoneContactMedium : numéro de téléphone professionnel EmailContactMedium : adresse e-mail FaxPhoneContactMedium : Numéro de fax GeographicAddressContactMedium : adresse physique (rue, ville, état, code postal) HomePhoneContactMedium : numéro de téléphone du domicile MobilePhoneContactMedium : Numéro de téléphone portable Type de données : chaîne
contactMedium.city	Ville de l’individu. Type de données : chaîne
contactMedium.country	Pays de la personne. Type de données : chaîne
contactMedium.emailAddress	Adresse e-mail du contact. Type de données : chaîne
contactMedium.locationId	Sys_id du lieu de la fête. Table : Emplacement [cmn_location] Type de données : chaîne
contactMedium.mediumType	Le type de milieu de contact. Indique l’attribut au niveau de l’entreprise qui spécifie le type de canal de contact utilisé. Valeurs possibles : e-mail téléphone professionnel Téléphone du domicile Téléphone mobile adresse postale Type de données : chaîne
contactMedium.numéroTéléphone	Numéro de téléphone de la personne. Type de données : chaîne
contactMedium.postCode	Code postal de la personne. Type de données : chaîne
contactMedium.preferred	Cette valeur est toujours fausse. Type de données : booléennes
contactMedium.stateOrProvince	Indique si l’emplacement est d’un État ou d’une province. Valeurs possibles : État Province (en anglais) Type de données : chaîne
contactMedium.street1	Décrit la rue. Type de données : chaîne
contactMedium.street2	Description complémentaire de la rue. Type de données : chaîne
nom de famille	Nom de famille de la personne. Type de données : chaîne
sexe	Sexe de la personne. Type de données : chaîne
givenName	Prénom de la personne. Type de données : chaîne
href	Lien relatif à l’enregistrement de l’utilisateur, du consommateur ou du contact. Type de données : chaîne
id	Sys_id de l’enregistrement de l’utilisateur, du consommateur ou du contact à récupérer. Tables : Consommateur [csm_consumer] ou Contact [customer_contact] Type de données : chaîne
deuxième prénom	Deuxième prénom de la personne. Type de données : chaîne
nom	Nom d’utilisateur de l’utilisateur ou de la personne à contacter. Type de données : chaîne
nationalité	Nationalité de la personne. Type de données : chaîne
partyCharacteristics	Liste des caractéristiques associées au parti. Type de données : tableau d’objets `"partyCharacteristics": [ { "@type": "String", "name": " String", "value": "String", "valueType": "String" } ]`
partyCharacteristics.@type	Lors de la sous-classe, cela définit le nom extensible de la sous-classe. Valeurs possibles : Caractéristique de chaîne Caractéristique du tableau de chaînes Caractéristique entière Caractéristique booléenne Type de données : chaîne
partyCharacteristics.name	Nom de la caractéristique de la partie. Type de données : chaîne
partyCharacteristics.valeur	Valeur de la caractéristique de la partie. Type de données : chaîne
partyCharacteristics.valueType	Type de données de la valeur de la caractéristique. Type de données : chaîne
partyOrPartyRole	Les rôles associés à cette partie sont définis où la partie est créée dans la table. Par exemple, `utilisateur`, `consommateur`, `contact client`. partyOrPartyRole Indique le type d’enregistrement récupéré dans l’opération. Si le sys_id fourni appartient à la table Consumer (Consommateur) [csm_consumer], il partyOrPartyRole.role est alors défini sur `Consumer (Consommateur`). De même, si le sys_id appartient à la table Contact [customer_contact], il partyOrPartyRole.role est défini sur `Contact`. Type de données : objet `"partyOrPartyRole": { "@type": "String", "role":"String" }`
partyOrPartyRole.@type	Cette valeur est toujours `Partie`. Type de données : chaîne
partyOrPartyRole.role	Type de rôle de la partie. Valeurs possibles : Consommateur Contact Type de données : chaîne
Fête connexe	Liste des parties ou des rôles de partie associés à cette partie. Type de données : tableau d’objets `"relatedParty": [ { "role": "String", "partyOrPartyRole": {Object} } ]`
relatedParty.partyOrPartyRole	Représente des informations sur la partie liée et le rôle qu’elle joue dans le contexte de l’enregistrement. Par exemple, si le rôle est `Société`, il partyOrPartyRole.id contient le sys_id de l’enregistrement Société [core_company] et partyOrPartyRole.name le nom de la société. Cette structure garantit que la référence au parti et son rôle sont explicitement définis et facilement identifiables. Type de données : objet `"partyOrPartyRole": { "@type": "String", "id": "String", "name": "String" }`
relatedParty.partyOrPartyRole.@type	Type de la partie liée. Valeur possible pour l’utilisateur : Organisation Individuel Type de données : chaîne
relatedParty.partyOrPartyRole.id	Sys_id de la partie liée. Valeur possible pour `l’utilisateur` : Société Département Valeur possible pour `le client` : compte Valeur possible pour `le consommateur` : utilisateur Type de données : chaîne
relatedParty.partyOrPartyRole.name	Nom de la partie liée. Type de données : chaîne
relatedParty.role	Rôle d’entreprise que la partie liée joue dans le contexte de l’entité actuelle. Valeurs possibles : Société (si la partie liée est l’utilisateur) Département (si la partie liée est l’utilisateur) Compte (si la partie liée est le client) Utilisateur (si la partie liée est un consommateur) Type de données : chaîne
statut	Marqueur qui indique l’état de la personne. Valeurs valides : actif : la personne a un statut actif. inactif : la personne est dans un état inactif. Type de données : booléennes
Titre	Préfixe ou titre de la personne. Par exemple, `Dr.`, `M.`, `Mme`). Type de données : chaîne

Demande cURL

Renvoie les champs spécifiés pour les enregistrements individuels de gestion des parties.

curl "http://instance.servicenow.com/api/sn_tmf_api/v1/party/individual" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--user 'user':'password'
--data "{
    \"id\": \"98765\",
    \"name\": \"Jane Smith\",
    \"givenName\": \"Jane\",
    \"middleName\": \"B.\",
    \"familyName\": \"Smith\",
    \"gender\": \"female\",
    \"nationality\": \"American\",
    \"title\": \"Ms\",
    \"contactMedium\": [
      {
        \"preferred\": true,
        \"mediumType\": \"email\",
        \"emailAddress\": \"jane.smith@example.com\",
        \"@type\": \"EmailContactMedium\"
      },
      {
        \"preferred\": false,
        \"mediumType\": \"mobilePhone\",
        \"phoneNumber\": \"+1-416-555-1234\",
        \"@type\": \"PhoneContactMedium\"
      },
      {
        \"preferred\": false,
        \"mediumType\": \"businessPhone\",
        \"phoneNumber\": \"+1-416-555-5678\",
        \"@type\": \"BusinessPhoneContactMedium\"
      },
      {
        \"preferred\": false,
        \"mediumType\": \"fax\",
        \"fax\": \"987654321\",
        \"@type\": \"FaxContactMedium\"
      },
      {
        \"preferred\": false,
        \"mediumType\": \"homePhone\",
        \"phoneNumber\": \"+1-416-555-4321\",
        \"@type\": \"HomePhoneContactMedium\"
      },
      {
        \"preferred\": false,
        \"mediumType\": \"postalAddress\",
        \"@type\": \"GeographicAddressContactMedium\",
        \"locationId\": \"12345678901234567\",
        \"city\": \"Toronto\",
        \"country\": \"Canada\",
        \"postCode\": \"M5H 2N2\",
        \"stateOrProvince\": \"Ontario\",
        \"street1\": \"123 Queen St W\",
        \"street2\": \"Suite 1500\"
      }
    ],
    \"externalReference\": [
      {
        \"externalIdentifierType\": \"linkedin\",
        \"id\": \"http://linkedin.com/in/janesmith\"
      }
    ],
    \"partyCharacteristic\": [
      {
        \"name\": \"notes\",
        \"value\": \"General consumer information.\",
        \"valueType\": \"string\",
        \"@type\": \"string\"
      },
      {
        \"name\": \"userName\",
        \"value\": \"janesmith\",
        \"valueType\": \"string\",
        \"@type\": \"string\"
      },
      {
        \"name\": \"vip\",
        \"value\": false,
        \"valueType\": \"boolean\",
        \"@type\": \"string\"
      },
      {
        \"name\": \"source\",
        \"value\": \"CRM System\",
        \"valueType\": \"string\",
        \"@type\": \"string\"
      },
      {
        \"name\": \"dateFormat\",
        \"value\": \"yyyy-mm-dd\",
        \"valueType\": \"string\",
        \"@type\": \"string\"
      },
      {
        \"name\": \"timeformat\",
        \"value\": \"HH:mm:ss (24 hour)\",
        \"valueType\": \"string\",
        \"@type\": \"string\"
      },
      {
        \"name\": \"notification\",
        \"value\": \"Disabled\",
        \"valueType\": \"string\",
        \"@type\": \"string\"
      }
    ],
    \"relatedParty\": [
      {
        \"role\": \"User\",
        \"partyOrPartyRole\": {
          \"id\": \"c456def03710200044e0bfc8bcbe5d99\",
          \"name\": \"Global Corp\",
          \"@type\": \"Individual\"
        }
      }
    ],
    \"status\": \"active\",
    \"@type\": \"Individual\",
    \"partyOrPartyRole\": {
      \"role\": \"Consumer\",
      \"@type\": \"Party\"
    }
  }" \

Corps de la réponse.

{
  "id": "83e588a17b6062105e0d5494548cb65d",
"href": "api/sn_tmf_api/party/individual/83e588a17b6062105e0d5494548cb65d",
  "name": "Jane Smith",
  "givenName": "Jane",
  "middleName": "B.",
  "familyName": "Smith",
  "gender": "female",
  "nationality": "American",
  "title": "Ms",
  "contactMedium": [
    {
      "preferred": true,
      "mediumType": "email",
      "emailAddress": "jane.smith@example.com",
      "@type": "EmailContactMedium"
    },
    {
      "preferred": false,
      "mediumType": "mobilePhone",
      "phoneNumber": "+1-416-555-1234",
      "@type": "PhoneContactMedium"
    },
    {
      "preferred": false,
      "mediumType": "businessPhone",
      "phoneNumber": "+1-416-555-5678",
      "@type": "BusinessPhoneContactMedium"
    },
    {
      "preferred": false,
      "mediumType": "fax",
      "fax": "987654321",
      "@type": "FaxContactMedium"
    },
    {
      "preferred": false,
      "mediumType": "homePhone",
      "phoneNumber": "+1-416-555-4321",
      "@type": "HomePhoneContactMedium"
    },
    {
      "preferred": false,
      "mediumType": "postalAddress",
      "@type": "GeographicAddressContactMedium",
      "locationId": "03e588a17be062105e0d5494548cb68c",
      "city": "Toronto",
      "country": "Canada",
      "postCode": "M5H 2N2",
      "stateOrProvince": "Ontario",
      "street1": "123 Queen St W",
      "street2": "Suite 1500"
    }
  ],
  "externalReference": [
    {
      "externalIdentifierType": "linkedin",
      "id": "http://linkedin.com/in/janesmith"
    }
  ],
  "partyCharacteristic": [
    {
      "name": "notes",
      "value": "General consumer information.",
      "valueType": "string",
      "@type": "string"
    },
    {
      "name": "userName",
      "value": "janesmith",
      "valueType": "string",
      "@type": "string"
    },
    {
      "name": "vip",
      "value": false,
      "valueType": "boolean",
      "@type": "string"
    },
    {
      "name": "source",
      "value": "CRM System",
      "valueType": "string",
      "@type": "string"
    },
    {
      "name": "dateFormat",
      "value": "yyyy-mm-dd",
      "valueType": "string",
      "@type": "string"
    },
    {
      "name": "timeformat",
      "value": "HH:mm:ss (24 hour)",
      "valueType": "string",
      "@type": "string"
    },
    {
      "name": "notification",
      "value": "Disabled",
      "valueType": "string",
      "@type": "string"
    }
  ],
  "relatedParty": [
    {
      "role": "User",
      "partyOrPartyRole": {
        "id": "c456def03710200044e0bfc8bcbe5d99",
        "name": "Global Corp",
        "@type": "Individual"
      }
    }
  ],
  "status": "active",
  "@type": "Individual",
  "partyOrPartyRole": {
    "role": "Consumer",
    "@type": "Party"
  },
   "warning": [
    "relatedParty[0] is incorrect. User does not exist"
  ]
}

Gestion des parties : POST /api/sn_tmf_api/v1/party/organization

Crée un nouvel enregistrement d’organisation de partie dans les tables Compte [customer_account].

Format d'URL

URL avec version : /api/sn_tmf_api/v1/party/organization

URL par défaut : /api/sn_tmf_api/v1/party/organization

Paramètres de demande pris en charge

Tableau 49. Paramètres de chemin d'accès
Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par exemple, `v1` ou `v2`. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison autre que la plus récente. Type de données : chaîne

Tableau 50. Paramètres de requête
Nom	Description
Néant

Tableau 51. Paramètres de corps de demande (XML ou JSON)
Nom	Description
@type	Cette valeur est toujours `Organisation`. Type de données : chaîne
contactMedium	Liste des moyens de contacter la partie. Un moyen de contact représente la façon dont vous communiquez ou atteignez une partie comme une personne ou une organisation. Par exemple, un canal ou une méthode de contact associé à cette partie. Type de données : tableau d’objets `"contactMedium": [ { "@type": "String", "city": "String", "country": "String", "emailAddress": "String", "locationId": "String", "mediumType": "String", "phoneNumber": "String", "postCode": "String", "preferred": "Boolean", "stateOrProvince": "String", "street1": "String", "street2": "String" } ]`
contactMedium.@type	Type de support de contact. Type de partie qui contacte. Indique le type de schéma ou de sous-classe spécifique de l’objet. Valeurs possibles : BusinessPhoneContactMedium : numéro de téléphone professionnel EmailContactMedium : adresse e-mail FaxPhoneContactMedium : Numéro de fax GeographicAddressContactMedium : adresse physique (rue, ville, état, code postal) HomePhoneContactMedium : numéro de téléphone du domicile MobilePhoneContactMedium : Numéro de téléphone portable Type de données : chaîne
contactMedium.city	Ville de l’organisation. Type de données : chaîne
contactMedium.country	Pays de l’organisation. Type de données : chaîne
contactMedium.emailAdress	Adresse e-mail du contact de l’organisation. Type de données : chaîne
contactMedium.locationId	Sys_id de l’emplacement. Table : Emplacement [cmn_location] Type de données : chaîne
contactMedium.mediumType	Le type de milieu de contact. Valeurs possibles : téléphone professionnel e-mail faxPhone Téléphone du domicile Téléphone mobile adresse postale Type de données : chaîne
contactMedium.numéroTéléphone	Numéro de téléphone du contact de l’organisation. Type de données : chaîne
contactMedium.postCode	Code postal de l’organisation. Type de données : chaîne
contactMedium.preferred	Cette valeur est toujours `fausse`. Type de données : booléennes
contactMedium.stateOrProvince	Indique si l’emplacement est d’un État ou d’une province. Valeurs possibles : État Province (en anglais) Type de données : chaîne
contactMedium.street1	Décrit la rue. Type de données : chaîne
contactMedium.street2	Description complémentaire de la rue. Type de données : chaîne
Référence externe	Liste des identificateurs de la partie dans un système externe. Type de données : tableau d’objets `"externalReference": [ { "externalIdentifierType": "String", "name": "String" } ]`
Référenceexterne.TypeIdentificateur externe	Type d’entité au sein du système externe. Type de données : chaîne
externalReference.name	Nom explicite du système externe ou de la référence. Type de données : chaîne
href	Lien relatif à l’enregistrement de compte (URI). Table : Compte [customer_account] Type de données : chaîne
id	Sys_id de l’enregistrement du compte d’entité externe. Table : Compte [customer_account] Type de données : chaîne
nom légal	Nom juridique de l’organisation. Type de données : chaîne
nom	Nom de l’organisation. Type de données : chaîne
partyCharacteristics	Liste des caractéristiques qu’un groupe peut adopter. Type de données : tableau d’objets `"partyCharacteristics": [ { "@type": "String" "name": "String", "value": "String", "valueType": "String" } ]`
partyCharacteristics.@type	Lors de la sous-classe, @type définit le nom extensible de la sous-classe. Valeur possible : Caractéristique booléenne Caractéristique entière Caractéristique du tableau de chaînes Caractéristique de chaîne Type de données : chaîne
partyCharacteristics.name	Nom de la caractéristique de la partie. Type de données : chaîne
partyCharacteristics.valeur	Valeur de la caractéristique de la partie. Type de données : chaîne
partyCharacteristics.valueType	Type de données de la valeur de la caractéristique. Type de données : chaîne
partyOrPartyRole	Les rôles associés à cette partie sont définis à l’endroit où la partie est créée dans la table. Par exemple, `Société` ou `Compte`. partyOrPartyRole Indique le type d’enregistrement récupéré dans l’opération. Si le sys_id fourni appartient à la table Compte [customer_account], alors partyOrPartyRole.role il est défini sur `Compte`. De même, si le sys_id appartient à la table Société [core_company], il partyOrPartyRole.role est défini sur `Société`. Type de données : objet `"partyOrPartyRole": { "@type": "String", "name":"String", "role":"String", }`
PartyOrPartyRole.@type	Cette valeur est toujours `fête`. Type de données : chaîne
PartyOrPartyRole.name	Définit le type de compte ou de société. Type de données : chaîne
PartyOrPartyRole.role	Type de rôle. Valeur possible : Compte Société Type de données : chaîne
Fête connexe	Liste des parties ou des rôles de partie associés à cette partie. Type de données : tableau d’objets `"relatedParty": [ { "partyOrPartyRole": {Object}, "role": "String" } ]`
relatedParty.partyOrPartyRole	Rôles associés à cette partie. Type de données : tableau d’objets `"partyOrPartyRole": [ { "@type": "String", "id": "String", "name": "String", } ]`
relatedParty.partyOrPartyRole.@type	Type de la partie liée. La valeur est toujours `Organisation`. Type de données : chaîne
relatedParty.partyOrPartyRole.id	Sys_id de la partie liée. Valeur possible : Contact Autre Type de données : chaîne
relatedParty.partyOrPartyRole.name	Nom de la partie liée. Type de données : chaîne
relatedParty.role	Rôle joué par la partie liée ou le rôle de partie dans le contexte de l’entité spécifique à laquelle il est lié. Valeurs possibles : Contact Autre Type de données : chaîne
statut	Marqueur qui indique l’état de l’organisation. Valeurs valides : actif : l’organisation est active. inactif : l’organisation est inactive. Type de données : booléennes
Nom du trading	Nom sous lequel l’organisation exerce ses activités. Type de données : chaîne

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.

Tableau 52. En-têtes de demandes
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

Tableau 53. En-têtes de réponses
En-tête	Description
Néant

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.

Tableau 54. Codes d'état
Code d'état	Description
200	Réussi. La demande a été traitée avec succès.

Paramètres du corps de la réponse (JSON ou XML)


Nom	Description
@type	Cette valeur est toujours `Organisation`. Type de données : chaîne
contactMedium	Liste des moyens de contacter la partie. Un moyen de contact représente la façon dont vous communiquez ou atteignez une partie comme une personne ou une organisation. Par exemple, un canal ou une méthode de contact associé à cette partie. Type de données : tableau d’objets `"contactMedium": [ { "@type": "String", "city": "String", "country": "String", "emailAddress": "String", "locationId": "String", "mediumType": "String", "phoneNumber": "String", "postCode": "String", "preferred": "Boolean", "stateOrProvince": "String", "street1": "String", "street2": "String" } ]`
contactMedium.@type	Type de support de contact. Type de partie qui contacte. Indique le type de schéma ou de sous-classe spécifique de l’objet. Valeurs possibles : BusinessPhoneContactMedium : numéro de téléphone professionnel EmailContactMedium : adresse e-mail FaxPhoneContactMedium : Numéro de fax GeographicAddressContactMedium : adresse physique (rue, ville, état, code postal) HomePhoneContactMedium : numéro de téléphone du domicile MobilePhoneContactMedium : Numéro de téléphone portable Type de données : chaîne
contactMedium.city	Ville de l’organisation. Type de données : chaîne
contactMedium.country	Pays de l’organisation. Type de données : chaîne
contactMedium.emailAdress	Adresse e-mail du contact de l’organisation. Type de données : chaîne
contactMedium.locationId	Sys_id de l’emplacement. Table : Emplacement [cmn_location] Type de données : chaîne
contactMedium.mediumType	Le type de milieu de contact. Valeurs possibles : téléphone professionnel e-mail faxPhone Téléphone du domicile Téléphone mobile adresse postale Type de données : chaîne
contactMedium.numéroTéléphone	Numéro de téléphone du contact de l’organisation. Type de données : chaîne
contactMedium.postCode	Code postal de l’organisation. Type de données : chaîne
contactMedium.preferred	Cette valeur est toujours `fausse`. Type de données : booléennes
contactMedium.stateOrProvince	Indique si l’emplacement est d’un État ou d’une province. Valeurs possibles : État Province (en anglais) Type de données : chaîne
contactMedium.street1	Décrit la rue. Type de données : chaîne
contactMedium.street2	Description complémentaire de la rue. Type de données : chaîne
Référence externe	Liste des identificateurs de la partie dans un système externe. Type de données : tableau d’objets `"externalReference": [ { "externalIdentifierType": "String", "name": "String" } ]`
Référenceexterne.TypeIdentificateur externe	Type d’entité au sein du système externe. Type de données : chaîne
externalReference.name	Nom explicite du système externe ou de la référence. Type de données : chaîne
href	Lien relatif à l’enregistrement de compte (URI). Table : Compte [customer_account] Type de données : chaîne
id	Sys_id de l’enregistrement du compte d’entité externe. Table : Compte [customer_account] Type de données : chaîne
nom légal	Nom juridique de l’organisation. Type de données : chaîne
nom	Nom de l’organisation. Type de données : chaîne
partyCharacteristics	Liste des caractéristiques qu’un groupe peut adopter. Type de données : tableau d’objets `"partyCharacteristics": [ { "@type": "String" "name": "String", "value": "String", "valueType": "String" } ]`
partyCharacteristics.@type	Lors de la sous-classe, @type définit le nom extensible de la sous-classe. Valeur possible : Caractéristique booléenne Caractéristique entière Caractéristique du tableau de chaînes Caractéristique de chaîne Type de données : chaîne
partyCharacteristics.name	Nom de la caractéristique de la partie. Type de données : chaîne
partyCharacteristics.valeur	Valeur de la caractéristique de la partie. Type de données : chaîne
partyCharacteristics.valueType	Type de données de la valeur de la caractéristique. Type de données : chaîne
partyOrPartyRole	Les rôles associés à cette partie sont définis à l’endroit où la partie est créée dans la table. Par exemple, `Société` ou `Compte`. partyOrPartyRole Indique le type d’enregistrement récupéré dans l’opération. Si le sys_id fourni appartient à la table Compte [customer_account], alors partyOrPartyRole.role il est défini sur `Compte`. De même, si le sys_id appartient à la table Société [core_company], il partyOrPartyRole.role est défini sur `Société`. Type de données : objet `"partyOrPartyRole": { "@type": "String", "name":"String", "role":"String", }`
PartyOrPartyRole.@type	Cette valeur est toujours `fête`. Type de données : chaîne
PartyOrPartyRole.name	Définit le type de compte ou de société. Type de données : chaîne
PartyOrPartyRole.role	Type de rôle. Valeur possible : Compte Société Type de données : chaîne
Fête connexe	Liste des parties ou des rôles de partie associés à cette partie. Type de données : tableau d’objets `"relatedParty": [ { "partyOrPartyRole": {Object}, "role": "String" } ]`
relatedParty.partyOrPartyRole	Rôles associés à cette partie. Type de données : tableau d’objets `"partyOrPartyRole": [ { "@type": "String", "id": "String", "name": "String", } ]`
relatedParty.partyOrPartyRole.@type	Type de la partie liée. La valeur est toujours `Organisation`. Type de données : chaîne
relatedParty.partyOrPartyRole.id	Sys_id de la partie liée. Valeur possible : Contact Autre Type de données : chaîne
relatedParty.partyOrPartyRole.name	Nom de la partie liée. Type de données : chaîne
relatedParty.role	Rôle joué par la partie liée ou le rôle de partie dans le contexte de l’entité spécifique à laquelle il est lié. Valeurs possibles : Contact Autre Type de données : chaîne
statut	Marqueur qui indique l’état de l’organisation. Valeurs valides : actif : l’organisation est active. inactif : l’organisation est inactive. Type de données : booléennes
Nom du trading	Nom sous lequel l’organisation exerce ses activités. Type de données : chaîne

Demande cURL

Renvoie les champs spécifiés pour les enregistrements de l’organisation de gestion des parties.

curl "http://instance.service-now.com/api/sn_tmf_api/v1/party/organization" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--user 'user':'password'
--data "{
  \"name\": \"SERVICENOW 144\",
  \"legalName\": \"Acme Corp Ltd.\",
  \"tradingName\": \"Acme Inc.\",
  \"contactMedium\": [
    {
      \"preferred\": true,
      \"mediumType\": \"email\",
      \"emailAddress\": \"athammhd@email.com\",
      \"@type\": \"EmailContactMedium\"
    },
    {
      \"preferred\": false,
      \"mediumType\": \"phone\",
      \"phoneNumber\": \"+1-202-555-0198\",
      \"@type\": \"PhoneContactMedium\"
    },
    {
      \"preferred\": false,
      \"mediumType\": \"businessPhone\",
      \"phoneNumber\": \"+1-202-555-0198\",
      \"@type\": \"BusinessPhoneContactMedium\"
    },
    {
      \"preferred\": false,
      \"mediumType\": \"homePhone\",
      \"phoneNumber\": \"+1-202-555-0198\",
      \"@type\": \"HomePhoneContactMedium\"
    },
    {
      \"preferred\": false,
      \"mediumType\": \"postalAddress\",
      \"validFor\": {
        \"startDateTime\": \"2017-03-15T07:49:25.246Z\"
      },
      \"@type\": \"GeographicAddressContactMedium\",
      \"city\": \"chennai\",
      \"country\": \"INDIA\",
      \"postCode\": \"608001\",
      \"stateOrProvince\": \"tamil nadu\",
      \"street1\": \"samcon street\",
      \"street2\": \"adyar,chennai\"
    }
  ],
  \"externalReference\": [
    {
      \"externalIdentifierType\": \"Instagram\",
      \"id\": \"Instagram\"
    }
  ],
  \"partyCharacteristic\": [
    {
      \"name\": \"notes\",
      \"value\": \"Testing for update the notes\",
      \"valueType\": \"string\",
      \"@type\": \"StringCharacteristics\"
    },
    {
      \"name\": \"customer\",
      \"value\": \"true\",
      \"valueType\": \"boolean\",
       \"@type\": \"StringCharacteristics\"
    },
    {
      \"name\": \"registrationCode\",
      \"value\": \"001\",
      \"valueType\": \"string\",
       \"@type\": \"StringCharacteristics\"
    },
    {
     \"name\": \"vendorType\",
     \"value\": [\"Hardware\"],
     \"valueType\": \"array\",
      \"@type\": \"StringArrayCharacteristic\"
     },
     {
      \"name\": \"industry\",
      \"value\": \"technology_services\",
      \"valueType\": \"choice\",
        \"@type\": \"StringCharacteristics\"
    },
    {
      \"name\": \"taxId\",
      \"value\": \"CTNUM1000123\",
      \"valueType\": \"string\",
       \"@type\": \"StringCharacteristics\"
    },
    {
      \"name\": \"numEmployees\",
      \"value\": \"EMP1000\",
      \"valueType\": \"integer\",
       \"@type\": \"StringCharacteristics\"
    },
    {
      \"name\": \"rankTier\",
      \"value\": \"rankTier\",
      \"valueType\": \"string\",
       \"@type\": \"StringCharacteristics\"
    },
    {
      \"name\": \"publiclyTraded\",
      \"value\": \"false\",
      \"valueType\": \"boolean\",
       \"@type\": \"StringCharacteristics\"
    },
    {
      \"name\": \"stockSymbol\",
      \"value\": \"Market\",
      \"valueType\": \"string\",
       \"@type\": \"StringCharacteristics\"
    },
    {
      \"name\": \"stockPrice\",
      \"value\": \"1000\",
      \"valueType\": \"string\",
       \"@type\": \"StringCharacteristics\"
    },
    {
      \"name\": \"vendor\",
      \"value\": \"false\",
      \"valueType\": \"boolean\",
       \"@type\": \"StringCharacteristics\"
    },
    {
      \"name\": \"manufacturer\",
      \"value\": \"false\",
      \"valueType\": \"boolean\",
       \"@type\": \"StringCharacteristics\"
    },
    {
      \"name\": \"marketCap\",
      \"value\": \"0\",
      \"valueType\": \"currency\",
       \"@type\": \"StringCharacteristics\"
    },
    {
      \"name\": \"profits\",
      \"value\": \"0\",
      \"valueType\": \"currency\",
       \"@type\": \"StringCharacteristics\"
    },
    {
      \"name\": \"revenuePerYear\",
      \"value\": \"0\",
      \"valueType\": \"currency\",
       \"@type\": \"StringCharacteristics\"
    }
  ],
  \"relatedParty\": [
    {
      \"role\": \"primaryContact\",
      \"partyOrPartyRole\": {
        \"id\": \"eaf68911c35420105252716b7d40ddde\",
        \"name\": \"John Doe\",
        \"@type\": \"Individual\"
      }
    },
    {
      \"role\": \"other\",
      \"partyOrPartyRole\": {
        \"id\": \"776a22ea11f43110f877366201dea6b7\",
        \"name\": \"Mary Star\",
        \"@type\": \"Individual\"
      }
    }
  ],
  \"organizationChildRelationship\": [
    {
      \"relationshipType\": \"partneraccount\",
      \"organization\": {
        \"id\": \"0fef075b2fe06a10b79db3bf42faf31a\",
        \"name\": \"mhd\",
        \"@type\": \"Organization\"
      }
    }
  ],
  \"organizationParentRelationship\": 
    {
      \"relationshipType\": \"Account\",
      \"organization\": {
        \"id\": \"9e2fd2ee11b43110f877366201dea674\",
        \"name\": \"Global Holdings Ltd.\",
        \"@type\": \"Organization\"
      }
    },
  \"status\": \"active\",
  \"@type\": \"Organization\",
  \"partyOrPartyRole\": {
    \"@type\":\"Party\",
    \"name\":\"Customer\",
    \"role\": \"Account\" 
  }
}" \

Corps de la réponse.

{
   "name": "SERVICENOW 144",
   "legalName": "Acme Corp Ltd.",
   "tradingName": "Acme Inc.",
   "contactMedium": [
     {
       "preferred": true,
       "mediumType": "email",
       "emailAddress": "athammhd@email.com",
       "@type": "EmailContactMedium"
     },
     {
       "preferred": false,
       "mediumType": "phone",
       "phoneNumber": "+1-202-555-0198",
       "@type": "PhoneContactMedium"
     },
     {
       "preferred": false,
       "mediumType": "businessPhone",
       "phoneNumber": "+1-202-555-0198",
       "@type": "BusinessPhoneContactMedium"
     },
     {
       "preferred": false,
       "mediumType": "homePhone",
       "phoneNumber": "+1-202-555-0198",
       "@type": "HomePhoneContactMedium"
     },
     {
       "preferred": false,
       "mediumType": "postalAddress",
       "validFor": {
         "startDateTime": "2017-03-15T07:49:25.246Z"
       },
       "@type": "GeographicAddressContactMedium",
       "city": "chennai",
       "country": "INDIA",
       "postCode": "608001",
       "stateOrProvince": "tamil nadu",
       "street1": "samcon street",
       "street2": "adyar,chennai"
     }
   ],
   "externalReference": [
     {
       "externalIdentifierType": "Instagram",
       "id": "Instagram"
     }
   ],
   "partyCharacteristic": [
     {
       "name": "notes",
       "value": "Testing for update the notes",
       "valueType": "string",
       "@type": "StringCharacteristics"
     },
     {
       "name": "customer",
       "value": "true",
       "valueType": "boolean",
        "@type": "StringCharacteristics"
     },
     {
       "name": "registrationCode",
       "value": "001",
       "valueType": "string",
        "@type": "StringCharacteristics"
     },
     {
      "name": "vendorType",
      "value": ["Hardware"],
      "valueType": "array",
       "@type": "StringArrayCharacteristic"
      },
      {
       "name": "industry",
       "value": "technology_services",
       "valueType": "choice",
         "@type": "StringCharacteristics"
     },
     {
       "name": "taxId",
       "value": "CTNUM1000123",
       "valueType": "string",
        "@type": "StringCharacteristics"
     },
     {
       "name": "numEmployees",
       "value": "EMP1000",
       "valueType": "integer",
        "@type": "StringCharacteristics"
     },
     {
       "name": "rankTier",
       "value": "rankTier",
       "valueType": "string",
        "@type": "StringCharacteristics"
     },
     {
       "name": "publiclyTraded",
       "value": "false",
       "valueType": "boolean",
        "@type": "StringCharacteristics"
     },
     {
       "name": "stockSymbol",
       "value": "Market",
       "valueType": "string",
        "@type": "StringCharacteristics"
     },
     {
       "name": "stockPrice",
       "value": "1000",
       "valueType": "string",
        "@type": "StringCharacteristics"
     },
     {
       "name": "vendor",
       "value": "false",
       "valueType": "boolean",
        "@type": "StringCharacteristics"
     },
     {
       "name": "manufacturer",
       "value": "false",
       "valueType": "boolean",
        "@type": "StringCharacteristics"
     },
     {
       "name": "marketCap",
       "value": "0",
       "valueType": "currency",
        "@type": "StringCharacteristics"
     },
     {
       "name": "profits",
       "value": "0",
       "valueType": "currency",
        "@type": "StringCharacteristics"
     },
     {
       "name": "revenuePerYear",
       "value": "0",
       "valueType": "currency",
        "@type": "StringCharacteristics"
     }
   ],
   "relatedParty": [
     {
       "role": "primaryContact",
       "partyOrPartyRole": {
         "id": "eaf68911c35420105252716b7d40ddde",
         "name": "John Doe",
         "@type": "Individual"
       }
     },
     {
       "role": "other",
       "partyOrPartyRole": {
         "id": "776a22ea11f43110f877366201dea6b7",
         "name": "Mary Star",
         "@type": "Individual"
       }
     }
   ],
   "organizationChildRelationship": [
     {
       "relationshipType": "partneraccount",
       "organization": {
         "id": "0fef075b2fe06a10b79db3bf42faf31a",
         "name": "mhd",
         "@type": "Organization"
       }
     }
   ],
   "organizationParentRelationship": 
     {
       "relationshipType": "Account",
       "organization": {
         "id": "9e2fd2ee11b43110f877366201dea674",
         "name": "Global Holdings Ltd.",
         "@type": "Organization"
       }
     },
   "status": "active",
   "@type": "Organization",
   "partyOrPartyRole": {
     "@type":"Party",
     "name":"Customer",
     "role": "Account" 
   }
 }