--- sourceDocument: Xanadu-API-Referenz sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/de-DE/xanadu/api-reference Release : - xanadu ft:locale : - de-DE ft:publication_title : - Xanadu-API-Referenz ft:clusterId : - crapiref bundleId : - crapiref workflow : - Creator --- # Verbraucher-API # Verbraucher-API {#ariaid-title1} * Freigeben Version: Xanadu * * Aktualisiert 1. August 2024 * * ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 13 Minuten Lesedauer Die Consumer -API bietet Endpunkte zum Abrufen und Aktualisieren von Kundenservice-Management (CSM) -Verbraucherdatensätzen. Darüber hinaus können Sie beim Erstellen eines Verbrauchers neue Social Media-Profildatensätze generieren. Die Consumer API erfordert das Plugin „Customer Service" (com.sn_customerservice) und wird im `Now` -Namespace bereitgestellt. Benutzer benötigen die Rolle csm_ws_integration für vollständigen API-Zugriff. ## Verbraucher: GET /now/consumer {#ariaid-title2} Ruft einen angegebenen Satz von Kundenservice-Management (CSM) Verbraucherdatensätzen ab. ### URL-Format URL mit Versionsnummer: /api/now/{api_version}/consumer Standard-URL: /api/now/consumer ### Unterstützte Anforderungsparameter {#consumer-GET__entry__2}{#consumer-GET__version-RESTAPI} | Name | Beschreibung | |-|-| | api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge | [Tabelle : 1. Pfadparameter] {#consumer-GET__entry__6}{#consumer-GET__sysparm-limit-entry}{#consumer-GET__sysparm-offset-entry}{#consumer-GET__sysparm-query-entry} | Name | Beschreibung | |-|-| | sysparm_limit | Maximale Anzahl der zurückzugebenden Datensätze. Verwenden Sie für Anforderungen, die diese Anzahl von Datensätzen überschreiten, den Parameter sysparm_offset, um den Datensatzabruf zu paginieren. In der Antwort wird der boolesche Parameter hasMore zurückgegeben. Gibt an, ob weitere Datensätze zurückgegeben werden, die die Filterkriterien erfüllen. Datentyp: Zahl Standard: 10 | | sysparm_offset | Startdatensatzindex, für den der Datensatz abgerufen werden soll. Verwenden Sie diesen Wert, um den Datensatzabruf zu paginieren. Diese Funktion ermöglicht das Abrufen aller Datensätze in kleinen, verwaltbaren Abschnitten, unabhängig von der Anzahl der Datensätze. Wenn zum Beispiel dieser Endpunkt zum ersten Mal aufgerufen wird, ist sysparm_offset auf „0" eingestellt. Verwenden Sie `sysparm_offset=sysparm_offset+sysparm_limit` zum einfachen Durchblättern aller verfügbaren Datensätze, bis das Ende aller Datensätze erreicht ist. Übergeben Sie keine negative Zahl im Parameter sysparm_offset. Datentyp: Zahl Standard: 0 | | sysparm_query | Codierte Abfrage zum Filtern der Ergebnismenge. Beispiel: `sysparm_query=caller_id=javascript:gs.getUserID()^active=wahr` Die codierte Abfrage unterstützt Sortieren nach. Verwenden Sie die Klauseln ORDERBY und ORDERBYDESC in sysparm_query, um Antworten anhand bestimmter Felder zu sortieren. Zum Beispiel filtert `sysparm_query=active=true^ORDERBYnumber^ORDERBYDESCcategory` alle aktiven Datensätze und sortiert die Ergebnisse zuerst in aufsteigender Reihenfolge nach Nummer und dann in absteigender Reihenfolge nach Kategorie. Wenn ein Teil der Abfrage ungültig ist, z. B. durch Angabe eines ungültigen Feldnamens, ignoriert die Instanz den ungültigen Teil. Es werden dann nur Zeilen unter Verwendung des gültigen Teils der Abfrage zurückgegeben. Sie können dieses Verhalten mithilfe der Eigenschaft glide.invalid_query.returns_no_rows steuern. Legen Sie diese Eigenschaft auf „true" fest, um bei einer ungültigen Abfrage keine Zeilen zurückzugeben. Hinweis: Diese Eigenschaft glide.invalid_query.returns_no_rows steuert das Verhalten aller Abfragen in der Instanz, beispielsweise in Listen, Skripts (GlideRecord.query()) und Webservice-APIs. Datentyp: Zeichenfolge | [Tabelle : 2. Abfrageparameter] {#consumer-GET__entry__14} | Element | Beschreibung | |-|-| | Keine | | [Tabelle : 3. Anforderungstextparameter (XML oder JSON)] ### Kopfzeilen Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter [Unterstützte REST API-Header](https://servicenow-prod.fluidtopics.net/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können."). {#consumer-GET__entry__18}{#consumer-GET__accept-RESTAPI} | Kopfzeile | Beschreibung | |-|-| | Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json | [Tabelle : 4. Anforderungskopfzeilen] {#consumer-GET__entry__22} | Kopfzeile | Beschreibung | |-|-| | Keine | | [Tabelle : 5. Antwortkopfzeilen] ### Statuscodes Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter [HTTP-Antwortcodes](https://servicenow-prod.fluidtopics.net/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können.")der REST-API. {#consumer-GET__entry__26}{#consumer-GET__entry-200-status-code}{#consumer-GET__entry-401-status-code}{#consumer-GET__entry-404-status-code}{#consumer-GET__entry-500-status-code} | Statuscode | Beschreibung | |-|-| | 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. | | 401 | Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben. | | 404 | Nicht gefunden. Das angeforderte Element wurde nicht gefunden. | | 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler. | [Tabelle : 6. Statuscodes] ### Parameter des Antworttexts (JSON oder XML) Der Endpunkt kann die folgenden JSON- oder XML-Elemente im Antworttext zurückgeben. Zusätzlich zur Liste der unten definierten Elemente (die die Elemente in einem Basissystem definieren) gibt der Endpunkt auch alle anwenderdefinierten Felder zurück, die der Tabelle „Verbraucher" \[csm_consumer\] hinzugefügt wurden. Weitere Informationen zu diesen Elementen finden Sie in Ihrer spezifischen Tabellendefinition \[SystemdefinitionTabellen\]. {#consumer-GET__csmconsumer_response_parms__entry__2}{#consumer-GET__consumertable-active-entry}{#consumer-GET__consumertable-business_phone-entry}{#consumer-GET__consumertable-city-entry}{#consumer-GET__consumertable-country-entry}{#consumer-GET__consumertable-date_format-entry}{#consumer-GET__consumertable-email-entry}{#consumer-GET__consumertable-fax-entry}{#consumer-GET__consumertable-first_name-entry}{#consumer-GET__consumertable-gender-entry}{#consumer-GET__consumertable-home_phone-entry}{#consumer-GET__consumertable-household-entry}{#consumer-GET__consumertable-last_name-entry}{#consumer-GET__consumertable-middle_name-entry}{#consumer-GET__consumertable-mobile_phone-entry}{#consumer-GET__consumertable-name-entry}{#consumer-GET__consumertable-notes-entry}{#consumer-GET__consumertable-notification-entry}{#consumer-GET__consumertable-number-entry}{#consumer-GET__consumertable-photo-entry}{#consumer-GET__consumertable-preferred_language-entry}{#consumer-GET__consumertable-prefix-entry}{#consumer-GET__consumertable-primary-entry}{#consumer-GET__consumertable-state-entry}{#consumer-GET__consumertable-street-entry}{#consumer-GET__consumertable-suffix-entry}{#consumer-GET__consumertable-sys_created_by-entry}{#consumer-GET__consumertable-sys_created_on-entry}{#consumer-GET__consumertable-sys_domain-entry}{#consumer-GET__consumertable-sys_id-entry}{#consumer-GET__consumertable-sys_mod_count-entry}{#consumer-GET__consumertable-sys_updated_by-entry}{#consumer-GET__consumertable-sys_updated_on-entry}{#consumer-GET__consumertable-time_format-entry}{#consumer-GET__consumertable-time_zone-entry}{#consumer-GET__consumertable-title-entry}{#consumer-GET__consumertable-user-entry}{#consumer-GET__consumertable-zip-entry} | Element | Beschreibung | |-|-| | aktiv | Kennzeichnung, die angibt, ob der Verbraucher aktiv ist Mögliche Werte: * wahr: Verbraucher aktiv * „falsch": Verbraucher deaktiviert {#consumer-GET__ul_asy_4b3_2hb} Datentyp: Boolesch Standardwert: true | | business_phone | Geschäftliche Telefonnummer des Verbrauchers Datentyp: Zeichenfolge Maximale Länge: 40 | | city | Stadt, in der der Verbraucher ansässig ist Datentyp: Zeichenfolge Maximale Länge: 100 | | country | Land, in dem der Verbraucher seinen Wohnsitz hat. Datentyp: Zeichenfolge Maximale Länge: 40 | | date_format | Format, in dem Datumsangaben angezeigt werden sollen. Gültige Werte: * TT-MM-JJJJ * TT/MM/JJJJ * TT.MM.JJJJ * MM-TT-JJJJ * JJJJ-MM-TT {#consumer-GET__ul_jsj_qwc_2hb} Datentyp: Zeichenfolge Maximale Länge: 40 Standard: leer (Systemdatumsformat) | | E-Mail | E-Mail-Adresse des Verbrauchers Datentyp: Zeichenfolge Maximale Länge: 100 | | Fax | Faxnummer des Verbrauchers Datentyp: Zeichenfolge Maximale Länge: 40 | | first_name | Vorname des Verbrauchers. Datentyp: Zeichenfolge Maximale Länge: 50 | | Geschlecht | Geschlecht des Verbrauchers Datentyp: Zeichenfolge Maximale Länge: 40 | | home_phone | Private Telefonnummer des Verbrauchers Datentyp: Zeichenfolge Maximale Länge: 40 | | Haushalt | Sys_id des Datensatzes, der die Merkmale des Haushalts beschreibt. Befindet sich in der Tabelle „Haushalt" \[csm_household\]. Datentyp: Zeichenfolge | | last_name | Nachname des Verbrauchers Datentyp: Zeichenfolge Maximale Länge: 50 | | Middle_name | Zweiter Vorname des Verbrauchers Datentyp: Zeichenfolge Maximale Länge: 50 | | mobile_phone | Mobiltelefonnummer des Verbrauchers. Datentyp: Zeichenfolge Maximale Länge: 40 | | name | Vollständiger Name des Verbrauchers; first_name+zweiter_Name+last_name Datentyp: Zeichenfolge Maximale Länge: 152 | | Notizen | Hinweise zum Verbraucher Datentyp: Zeichenfolge Maximale Länge: 4.000 | | Benachrichtigung | Gibt an, ob der Verbraucher Benachrichtigungen erhalten soll. Gültige Werte: * 1: Deaktiviert * 2: Aktiviert {#consumer-GET__ul_o5d_pyh_2hb} Datentyp: Ganzzahl Maximale Länge: 40 Standardwert: 2 | | Nummer | Eindeutige Nummer, die dem Verbraucher zugeordnet ist. Datentyp: Zeichenfolge Maximale Länge: 40 | | Foto | Foto des Verbrauchers Datentyp: Bild | | preferred_language | Primäre Sprache des Verbrauchers. Datentyp: Zeichenfolge Maximale Länge: 3 | | Präfix | Verbrauchernamenpräfix wie Dr., Mr., Mrs. oder Ms. Datentyp: Zeichenfolge Maximale Länge: 40 | | primär | Kennzeichnung, die angibt, ob dies der primäre Verbraucher ist. Mögliche Werte: * true: Primärer Verbraucher * false: Kein primärer Verbraucher {#consumer-GET__ul_yns_yb3_2hb} Datentyp: Boolesch Standardwert: false | | Staat | Bundesstaat, in dem der Verbraucher seinen Wohnsitz hat. Datentyp: Zeichenfolge Maximale Länge: 100 | | Straße | Straße des Verbrauchers. Datentyp: Zeichenfolge Maximale Länge: 255 | | Suffix | Namenssuffix für Verbraucher, z. B. jr., sr. oder II. Datentyp: Zeichenfolge | | sys_created_by | Benutzer, der den Verbraucherdatensatz erstellt hat. Datentyp: Zeichenfolge Maximale Länge: 40 | | sys_created_on | Datum und Uhrzeit der ursprünglichen Erstellung des Verbraucherdatensatzes. Datentyp: Zeichenfolge | | sys_domain | ServiceNow Domäne, in der sich die Verbraucherinformationen befinden. Datentyp: Zeichenfolge | | sys_id | Eindeutiger Bezeichner für den Verbraucher Datentyp: Zeichenfolge | | sys_mod_count | Angabe, wie oft die zugeordneten Verbraucherinformationen geändert wurden. Datentyp: Ganzzahl | | sys_tags | System-Tags. Datentyp: Zeichenfolge | | sys_updated_by | Anwender, der die Verbraucherinformationen zuletzt aktualisiert hat. Datentyp: Zeichenfolge Maximale Länge: 40 | | sys_updated_on | Datum und Uhrzeit der letzten Aktualisierung der Verbraucherinformationen. Datentyp: Zeichenfolge | | time_format | Format, in dem die Zeit angezeigt werden soll. Gültige Werte: * hh.mm.ss a: hh.mm.ss (12 Stunden) * hh:mm:ss a: hh:mm:ss (12 Stunden) * HH.mm.ss: hh.mm.ss (24 Stunden) * HH:mm:ss: hh:mm:ss (24 Stunden) {#consumer-GET__ul_kvg_gxc_2hb} Datentyp: Zeichenfolge Maximale Länge: 40 Standard: leer (Systemzeitformat) | | time_zone | Zeitzone des Verbrauchers, z. B. Kanada/Zentral oder USA/Ost. Datentyp: Zeichenfolge Maximale Länge: 40 | | Titel | Geschäftstitel des Verbrauchers, z. B. Manager, Softwareentwickler oder Auftragnehmer. Datentyp: Zeichenfolge Maximale Länge: 60 | | Anwender | Sys_id des Verbraucheranwenders. Befindet sich in der Tabelle „Verbraucherbenutzer" \[csm_consumer_user\]. Datentyp: Zeichenfolge | | Postleitzahl | Postleitzahl des Verbrauchers. Datentyp: Zeichenfolge Maximale Länge: 40 | [ ] ### cURL-Anforderung curl "https://instance.servicenow.com/api/now/consumer?sysparm_query=account=86837a386f0331003b3c498f5d3ee4ca&sysparm_limit=2&sysparm_offset=2>;rel="next" \ --request GET \ --header "Accept:application/json" \ --user "username":"password" { "result": [ { "country": "USA", "notes": "", "gender": "Male", "city": "Plano", "prefix": "", "sys_updated_on": "2016-08-12 00:19:12", "suffix": "", "title": "", "number": "CSMR0000004", "notification": "2", "sys_id": "01d8403fdb1b1200b6075200cf961941", "business_phone": "", "sys_updated_by": "prithvi", "mobile_phone": "", "street": "6900 Dallas Pkwy", "sys_created_on": "2016-06-16 19:20:13", "sys_domain": "global", "state": "TX", "fax": "", "first_name": "Harding", "email": "harding.asher@mailinator.com", "preferred_language": "", "sys_created_by": "guest", "zip": "75024", "home_phone": "", "time_format": "", "sys_mod_count": "8", "last_name": "Asher", "photo": "", "active": "true", "middle_name": "", "time_zone": "", "sys_tags": "", "name": "Harding Asher", "household": "", "date_format": "", "user": "c3d35d82c37122005871d44d81d3ae91", "primary": "false" }, { "country": "USA", "notes": "", "gender": "Male", "city": "San Francisco", "prefix": "", "sys_updated_on": "2016-08-12 00:20:27", "suffix": "", "title": "", "number": "CSMR0000002", "notification": "2", "sys_id": "a0488cfbdb1b1200b6075200cf9619db", "business_phone": "", "sys_updated_by": "prithvi", "mobile_phone": "", "street": "144 2nd St", "sys_created_on": "2016-06-16 19:17:44", "sys_domain": "global", "state": "CA", "fax": "", "first_name": "Sam", "email": "sam.collins@mailinator.com", "preferred_language": "", "sys_created_by": "guest", "zip": "94105", "home_phone": "", "time_format": "", "sys_mod_count": "13", "last_name": "Collins", "photo": "", "active": "true", "middle_name": "", "time_zone": "", "sys_tags": "", "name": "Sam Collins", "household": "", "date_format": "", "user": "64488cfbdb1b1200b6075200cf9619db", "primary": "false" } ] } ## Verbraucher: GET /now/consumer/{id} {#ariaid-title3} Ruft den angegebenen Verbraucherdatensatz Kundenservice-Management (CSM) ab. ### URL-Format URL mit Versionsnummer: /api/now/{api_version}/consumer/{id} Standard-URL: /api/now/consumer/{id} ### Unterstützte Anforderungsparameter {#consumer-GET-id__entry__2}{#consumer-GET-id__version-RESTAPI} | Name | Beschreibung | |-|-| | api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge | | id | Sys_id des zurückzugebenden Verbraucherdatensatzes. Befindet sich in der Tabelle „Verbraucher" \[csm_consumer\]. Datentyp: Zeichenfolge | [Tabelle : 7. Pfadparameter] {#consumer-GET-id__entry__8} | Name | Beschreibung | |-|-| | Keine | | [Tabelle : 8. Abfrageparameter] {#consumer-GET-id__entry__12} | Name | Beschreibung | |-|-| | Keine | | [Tabelle : 9. Anforderungstextparameter (XML oder JSON)] ### Kopfzeilen Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter [Unterstützte REST API-Header](https://servicenow-prod.fluidtopics.net/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können."). {#consumer-GET-id__entry__16}{#consumer-GET-id__accept-RESTAPI} | Kopfzeile | Beschreibung | |-|-| | Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json | [Tabelle : 10. Anforderungskopfzeilen] {#consumer-GET-id__entry__20} | Kopfzeile | Beschreibung | |-|-| | Keine | | [Tabelle : 11. Antwortkopfzeilen] ### Statuscodes Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter [HTTP-Antwortcodes](https://servicenow-prod.fluidtopics.net/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können.")der REST-API. {#consumer-GET-id__entry__24}{#consumer-GET-id__entry-200-status-code}{#consumer-GET-id__entry-401-status-code}{#consumer-GET-id__entry-500-status-code} | Statuscode | Beschreibung | |-|-| | 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. | | 401 | Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben. | | 404 | Gibt an, dass die Anforderung ungültig ist. Möglicherweise liegt einer der folgenden Gründe vor: * Angeforderter Fall ist nicht vorhanden. * Der Anwender hat keinen Zugriff auf den Verbraucherdatensatz. {#consumer-GET-id__ul_ubm_1jl_3v} | | 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler. | [Tabelle : 12. Statuscodes] ### Parameter des Antworttexts (JSON oder XML) Der Endpunkt kann die folgenden JSON- oder XML-Elemente im Antworttext zurückgeben. Zusätzlich zur Liste der unten definierten Elemente (die die Elemente in einem Basissystem definieren) gibt der Endpunkt auch alle anwenderdefinierten Felder zurück, die der Tabelle „Verbraucher" \[csm_consumer\] hinzugefügt wurden. Weitere Informationen zu diesen Elementen finden Sie in Ihrer spezifischen Tabellendefinition \[SystemdefinitionTabellen\]. {#consumer-GET-id__csmconsumer_response_parms__entry__2}{#consumer-GET-id__consumertable-active-entry}{#consumer-GET-id__consumertable-business_phone-entry}{#consumer-GET-id__consumertable-city-entry}{#consumer-GET-id__consumertable-country-entry}{#consumer-GET-id__consumertable-date_format-entry}{#consumer-GET-id__consumertable-email-entry}{#consumer-GET-id__consumertable-fax-entry}{#consumer-GET-id__consumertable-first_name-entry}{#consumer-GET-id__consumertable-gender-entry}{#consumer-GET-id__consumertable-home_phone-entry}{#consumer-GET-id__consumertable-household-entry}{#consumer-GET-id__consumertable-last_name-entry}{#consumer-GET-id__consumertable-middle_name-entry}{#consumer-GET-id__consumertable-mobile_phone-entry}{#consumer-GET-id__consumertable-name-entry}{#consumer-GET-id__consumertable-notes-entry}{#consumer-GET-id__consumertable-notification-entry}{#consumer-GET-id__consumertable-number-entry}{#consumer-GET-id__consumertable-photo-entry}{#consumer-GET-id__consumertable-preferred_language-entry}{#consumer-GET-id__consumertable-prefix-entry}{#consumer-GET-id__consumertable-primary-entry}{#consumer-GET-id__consumertable-state-entry}{#consumer-GET-id__consumertable-street-entry}{#consumer-GET-id__consumertable-suffix-entry}{#consumer-GET-id__consumertable-sys_created_by-entry}{#consumer-GET-id__consumertable-sys_created_on-entry}{#consumer-GET-id__consumertable-sys_domain-entry}{#consumer-GET-id__consumertable-sys_id-entry}{#consumer-GET-id__consumertable-sys_mod_count-entry}{#consumer-GET-id__consumertable-sys_updated_by-entry}{#consumer-GET-id__consumertable-sys_updated_on-entry}{#consumer-GET-id__consumertable-time_format-entry}{#consumer-GET-id__consumertable-time_zone-entry}{#consumer-GET-id__consumertable-title-entry}{#consumer-GET-id__consumertable-user-entry}{#consumer-GET-id__consumertable-zip-entry} | Element | Beschreibung | |-|-| | aktiv | Kennzeichnung, die angibt, ob der Verbraucher aktiv ist Mögliche Werte: * wahr: Verbraucher aktiv * „falsch": Verbraucher deaktiviert {#consumer-GET-id__ul_asy_4b3_2hb} Datentyp: Boolesch Standardwert: true | | business_phone | Geschäftliche Telefonnummer des Verbrauchers Datentyp: Zeichenfolge Maximale Länge: 40 | | city | Stadt, in der der Verbraucher ansässig ist Datentyp: Zeichenfolge Maximale Länge: 100 | | country | Land, in dem der Verbraucher seinen Wohnsitz hat. Datentyp: Zeichenfolge Maximale Länge: 40 | | date_format | Format, in dem Datumsangaben angezeigt werden sollen. Gültige Werte: * TT-MM-JJJJ * TT/MM/JJJJ * TT.MM.JJJJ * MM-TT-JJJJ * JJJJ-MM-TT {#consumer-GET-id__ul_jsj_qwc_2hb} Datentyp: Zeichenfolge Maximale Länge: 40 Standard: leer (Systemdatumsformat) | | E-Mail | E-Mail-Adresse des Verbrauchers Datentyp: Zeichenfolge Maximale Länge: 100 | | Fax | Faxnummer des Verbrauchers Datentyp: Zeichenfolge Maximale Länge: 40 | | first_name | Vorname des Verbrauchers. Datentyp: Zeichenfolge Maximale Länge: 50 | | Geschlecht | Geschlecht des Verbrauchers Datentyp: Zeichenfolge Maximale Länge: 40 | | home_phone | Private Telefonnummer des Verbrauchers Datentyp: Zeichenfolge Maximale Länge: 40 | | Haushalt | Sys_id des Datensatzes, der die Merkmale des Haushalts beschreibt. Befindet sich in der Tabelle „Haushalt" \[csm_household\]. Datentyp: Zeichenfolge | | last_name | Nachname des Verbrauchers Datentyp: Zeichenfolge Maximale Länge: 50 | | Middle_name | Zweiter Vorname des Verbrauchers Datentyp: Zeichenfolge Maximale Länge: 50 | | mobile_phone | Mobiltelefonnummer des Verbrauchers. Datentyp: Zeichenfolge Maximale Länge: 40 | | name | Vollständiger Name des Verbrauchers; first_name+zweiter_Name+last_name Datentyp: Zeichenfolge Maximale Länge: 152 | | Notizen | Hinweise zum Verbraucher Datentyp: Zeichenfolge Maximale Länge: 4.000 | | Benachrichtigung | Gibt an, ob der Verbraucher Benachrichtigungen erhalten soll. Gültige Werte: * 1: Deaktiviert * 2: Aktiviert {#consumer-GET-id__ul_o5d_pyh_2hb} Datentyp: Ganzzahl Maximale Länge: 40 Standardwert: 2 | | Nummer | Eindeutige Nummer, die dem Verbraucher zugeordnet ist. Datentyp: Zeichenfolge Maximale Länge: 40 | | Foto | Foto des Verbrauchers Datentyp: Bild | | preferred_language | Primäre Sprache des Verbrauchers. Datentyp: Zeichenfolge Maximale Länge: 3 | | Präfix | Verbrauchernamenpräfix wie Dr., Mr., Mrs. oder Ms. Datentyp: Zeichenfolge Maximale Länge: 40 | | primär | Kennzeichnung, die angibt, ob dies der primäre Verbraucher ist. Mögliche Werte: * true: Primärer Verbraucher * false: Kein primärer Verbraucher {#consumer-GET-id__ul_yns_yb3_2hb} Datentyp: Boolesch Standardwert: false | | Staat | Bundesstaat, in dem der Verbraucher seinen Wohnsitz hat. Datentyp: Zeichenfolge Maximale Länge: 100 | | Straße | Straße des Verbrauchers. Datentyp: Zeichenfolge Maximale Länge: 255 | | Suffix | Namenssuffix für Verbraucher, z. B. jr., sr. oder II. Datentyp: Zeichenfolge | | sys_created_by | Benutzer, der den Verbraucherdatensatz erstellt hat. Datentyp: Zeichenfolge Maximale Länge: 40 | | sys_created_on | Datum und Uhrzeit der ursprünglichen Erstellung des Verbraucherdatensatzes. Datentyp: Zeichenfolge | | sys_domain | ServiceNow Domäne, in der sich die Verbraucherinformationen befinden. Datentyp: Zeichenfolge | | sys_id | Eindeutiger Bezeichner für den Verbraucher Datentyp: Zeichenfolge | | sys_mod_count | Angabe, wie oft die zugeordneten Verbraucherinformationen geändert wurden. Datentyp: Ganzzahl | | sys_updated_by | Anwender, der die Verbraucherinformationen zuletzt aktualisiert hat. Datentyp: Zeichenfolge Maximale Länge: 40 | | sys_updated_on | Datum und Uhrzeit der letzten Aktualisierung der Verbraucherinformationen. Datentyp: Zeichenfolge | | time_format | Format, in dem die Zeit angezeigt werden soll. Gültige Werte: * hh.mm.ss a: hh.mm.ss (12 Stunden) * hh:mm:ss a: hh:mm:ss (12 Stunden) * HH.mm.ss: hh.mm.ss (24 Stunden) * HH:mm:ss: hh:mm:ss (24 Stunden) {#consumer-GET-id__ul_kvg_gxc_2hb} Datentyp: Zeichenfolge Maximale Länge: 40 Standard: leer (Systemzeitformat) | | time_zone | Zeitzone des Verbrauchers, z. B. Kanada/Zentral oder USA/Ost. Datentyp: Zeichenfolge Maximale Länge: 40 | | Titel | Geschäftstitel des Verbrauchers, z. B. Manager, Softwareentwickler oder Auftragnehmer. Datentyp: Zeichenfolge Maximale Länge: 60 | | Anwender | Sys_id des Verbraucheranwenders. Befindet sich in der Tabelle „Verbraucherbenutzer" \[csm_consumer_user\]. Datentyp: Zeichenfolge | | Postleitzahl | Postleitzahl des Verbrauchers. Datentyp: Zeichenfolge Maximale Länge: 40 | [ ] ### cURL-Anforderung curl "https://instance.servicenow.com/api/now/consumer/01d8403fdb1b1200b6075200cf961941 \ --request GET \ --header "Accept:application/json" \ --user "username":"password" { "result": { "country": "USA", "notes": "", "gender": "Male", "city": "Plano", "prefix": "", "sys_updated_on": "2016-08-12 00:19:12", "suffix": "", "title": "", "number": "CSMR0000004", "notification": "2", "sys_id": "01d8403fdb1b1200b6075200cf961941", "business_phone": "", "sys_updated_by": "prithvi", "mobile_phone": "", "street": "6900 Dallas Pkwy", "sys_created_on": "2016-06-16 19:20:13", "sys_domain": "global", "state": "TX", "fax": "", "first_name": "Harding", "email": "harding.asher@mailinator.com", "preferred_language": "", "sys_created_by": "guest", "zip": "75024", "home_phone": "", "time_format": "", "sys_mod_count": "8", "last_name": "Asher", "photo": "", "active": "true", "middle_name": "", "time_zone": "", "sys_tags": "", "name": "Harding Asher", "household": "", "date_format": "", "user": "c3d35d82c37122005871d44d81d3ae91", "primary": "false" } } ## Verbraucher: POST /now/consumer {#ariaid-title4} Erstellt einen neuen Kundenservice-Management (CSM) -Verbraucher. Darüber hinaus können Sie mit diesem Endpunkt ein Social Media-Profil für den Verbraucher erstellen. Um das Profil zu erstellen, müssen Sie die folgenden Parameter im Anforderungstext angeben: * social_channel * social_handle * social_handle_url {#consumer-POST__ul_ntx_lg4_pgb} Warnung: Dieser Endpunkt führt keine Parametervalidierung durch, da dies zu einem übermäßigen Overhead führen kann. Wenn ein Anforderungsparameter falsch geschrieben, ungültig oder vom Endpunkt nicht unterstützt wird, wird er ohne Warnung ignoriert. ### URL-Format URL mit Versionsnummer: /api/now/{api_version}/consumer Standard-URL: /api/now/consumer ### Unterstützte Anforderungsparameter {#consumer-POST__entry__2}{#consumer-POST__version-RESTAPI} | Name | Beschreibung | |-|-| | api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge | [Tabelle : 13. Pfadparameter] {#consumer-POST__entry__6} | Name | Beschreibung | |-|-| | Keine | | [Tabelle : 14. Abfrageparameter] {#consumer-POST__entry__10}{#consumer-POST__consumertable-active-entry}{#consumer-POST__consumertable-business_phone-entry}{#consumer-POST__consumertable-city-entry}{#consumer-POST__consumertable-country-entry}{#consumer-POST__consumertable-date_format-entry}{#consumer-POST__consumertable-email-entry}{#consumer-POST__consumertable-fax-entry}{#consumer-POST__consumertable-first_name-entry}{#consumer-POST__consumertable-gender-entry}{#consumer-POST__consumertable-home_phone-entry}{#consumer-POST__consumertable-household-entry}{#consumer-POST__consumertable-last_name-entry}{#consumer-POST__consumertable-middle_name-entry}{#consumer-POST__consumertable-mobile_phone-entry}{#consumer-POST__consumertable-name-entry}{#consumer-POST__consumertable-notes-entry}{#consumer-POST__consumertable-notification-entry}{#consumer-POST__consumertable-photo-entry}{#consumer-POST__consumertable-preferred_language-entry}{#consumer-POST__consumertable-prefix-entry}{#consumer-POST__consumertable-primary-entry}{#consumer-POST__consumertable-state-entry}{#consumer-POST__consumertable-street-entry}{#consumer-POST__consumertable-suffix-entry}{#consumer-POST__consumertable-time_format-entry}{#consumer-POST__consumertable-time_zone-entry}{#consumer-POST__consumertable-title-entry}{#consumer-POST__consumertable-user-entry}{#consumer-POST__consumertable-zip-entry} | Element | Beschreibung | |-|-| | aktiv | Kennzeichnung, die angibt, ob der Verbraucher aktiv ist Mögliche Werte: * wahr: Verbraucher aktiv * „falsch": Verbraucher deaktiviert {#consumer-POST__ul_asy_4b3_2hb} Datentyp: Boolesch Standardwert: true | | business_phone | Geschäftliche Telefonnummer des Verbrauchers Datentyp: Zeichenfolge Maximale Länge: 40 | | city | Stadt, in der der Verbraucher ansässig ist Datentyp: Zeichenfolge Maximale Länge: 100 | | country | Land, in dem der Verbraucher seinen Wohnsitz hat. Datentyp: Zeichenfolge Maximale Länge: 40 | | date_format | Format, in dem Datumsangaben angezeigt werden sollen. Gültige Werte: * TT-MM-JJJJ * TT/MM/JJJJ * TT.MM.JJJJ * MM-TT-JJJJ * JJJJ-MM-TT {#consumer-POST__ul_jsj_qwc_2hb} Datentyp: Zeichenfolge Maximale Länge: 40 Standard: leer (Systemdatumsformat) | | E-Mail | E-Mail-Adresse des Verbrauchers Datentyp: Zeichenfolge Maximale Länge: 100 | | Fax | Faxnummer des Verbrauchers Datentyp: Zeichenfolge Maximale Länge: 40 | | first_name | Vorname des Verbrauchers. Datentyp: Zeichenfolge Maximale Länge: 50 | | Geschlecht | Geschlecht des Verbrauchers Datentyp: Zeichenfolge Maximale Länge: 40 | | home_phone | Private Telefonnummer des Verbrauchers Datentyp: Zeichenfolge Maximale Länge: 40 | | Haushalt | Sys_id des Datensatzes, der die Merkmale des Haushalts beschreibt. Befindet sich in der Tabelle „Haushalt" \[csm_household\]. Datentyp: Zeichenfolge | | last_name | Nachname des Verbrauchers Datentyp: Zeichenfolge Maximale Länge: 50 | | Middle_name | Zweiter Vorname des Verbrauchers Datentyp: Zeichenfolge Maximale Länge: 50 | | mobile_phone | Mobiltelefonnummer des Verbrauchers. Datentyp: Zeichenfolge Maximale Länge: 40 | | name | Vollständiger Name des Verbrauchers; first_name+zweiter_Name+last_name Datentyp: Zeichenfolge Maximale Länge: 152 | | Notizen | Hinweise zum Verbraucher Datentyp: Zeichenfolge Maximale Länge: 4.000 | | Benachrichtigung | Gibt an, ob der Verbraucher Benachrichtigungen erhalten soll. Gültige Werte: * 1: Deaktiviert * 2: Aktiviert {#consumer-POST__ul_o5d_pyh_2hb} Datentyp: Ganzzahl Maximale Länge: 40 Standardwert: 2 | | Foto | Foto des Verbrauchers Datentyp: Bild | | preferred_language | Primäre Sprache des Verbrauchers. Datentyp: Zeichenfolge Maximale Länge: 3 | | Präfix | Verbrauchernamenpräfix wie Dr., Mr., Mrs. oder Ms. Datentyp: Zeichenfolge Maximale Länge: 40 | | primär | Kennzeichnung, die angibt, ob dies der primäre Verbraucher ist. Mögliche Werte: * true: Primärer Verbraucher * false: Kein primärer Verbraucher {#consumer-POST__ul_yns_yb3_2hb} Datentyp: Boolesch Standardwert: false | | Social_Channel | Social Media-Kanal, dem der Verbraucher zugeordnet ist, z. B. Twitter, Facebook oder Instagram. Datentyp: Zeichenfolge | | Social_handle | Anwender-Handle im Social Media-Kanal. Datentyp: Zeichenfolge | | Social_handle_url | URL zum Community-Kanal-Handle des Verbrauchers. Datentyp: Zeichenfolge | | Staat | Bundesstaat, in dem der Verbraucher seinen Wohnsitz hat. Datentyp: Zeichenfolge Maximale Länge: 100 | | Straße | Straße des Verbrauchers. Datentyp: Zeichenfolge Maximale Länge: 255 | | Suffix | Namenssuffix für Verbraucher, z. B. jr., sr. oder II. Datentyp: Zeichenfolge | | time_format | Format, in dem die Zeit angezeigt werden soll. Gültige Werte: * hh.mm.ss a: hh.mm.ss (12 Stunden) * hh:mm:ss a: hh:mm:ss (12 Stunden) * HH.mm.ss: hh.mm.ss (24 Stunden) * HH:mm:ss: hh:mm:ss (24 Stunden) {#consumer-POST__ul_kvg_gxc_2hb} Datentyp: Zeichenfolge Maximale Länge: 40 Standard: leer (Systemzeitformat) | | time_zone | Zeitzone des Verbrauchers, z. B. Kanada/Zentral oder USA/Ost. Datentyp: Zeichenfolge Maximale Länge: 40 | | Titel | Geschäftstitel des Verbrauchers, z. B. Manager, Softwareentwickler oder Auftragnehmer. Datentyp: Zeichenfolge Maximale Länge: 60 | | Anwender | Sys_id des Verbraucheranwenders. Befindet sich in der Tabelle „Verbraucherbenutzer" \[csm_consumer_user\]. Datentyp: Zeichenfolge | | Postleitzahl | Postleitzahl des Verbrauchers. Datentyp: Zeichenfolge Maximale Länge: 40 | [Tabelle : 15. Anforderungstextparameter (XML oder JSON)] ### Header Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter [Unterstützte REST API-Header](https://servicenow-prod.fluidtopics.net/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können."). {#consumer-POST__entry__76}{#consumer-POST__accept-JSON-only-entry-RESTAPI}{#consumer-POST__content_type-JSON-only-entry-RESTAPI} | Kopfzeile | Beschreibung | |-|-| | Akzeptieren | Datenformat des Antworttexts. Unterstützt nur application/json. | | Content-Type | Datenformat des Anforderungstexts. Unterstützt nur application/json. | [Tabelle : 16. Anforderungskopfzeilen] {#consumer-POST__entry__82} | Kopfzeile | Beschreibung | |-|-| | Keine | | [Tabelle : 17. Antwortkopfzeilen] ### Statuscodes Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter [HTTP-Antwortcodes](https://servicenow-prod.fluidtopics.net/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können.")der REST-API. {#consumer-POST__entry__86}{#consumer-POST__entry-401-status-code} | Statuscode | Beschreibung | |-|-| | 201 | Neuer Verbraucherdatensatz wurde erfolgreich erstellt. | | 400 | Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. | | 401 | Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben. | | 500 | Interner Serverfehler. Im serverseitigen Code ein logischer Fehler aufgetreten. | [Tabelle : 18. Statuscodes] ### Parameter des Antworttexts (JSON oder XML) {#consumer-POST__entry__96} | Element | Beschreibung | |-|-| | Ergebnis | Sys_id des neu erstellten Verbraucherdatensatzes. Datentyp: Zeichenfolge | [ ] ### cURL-Anforderung curl -X POST "https://instance.servicenow.com/api/now/consumer" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -d " { \ "country": "USA", \ "notes": "Never comes in before 10am", \ "gender": "Female", \ "city": "San Marcos", \ "prefix": "Ms", \ "title": "Director", \ "notification": "1", \ "business_phone": "(555)555-1234", \ "mobile_phone": "(555)555-1235", \ "street": "123 Sesame St", \ "state": "CA", \ "fax": "(555)555-1236", \ "first_name": "Jane", \ "zip": "92001", \ "home_phone": "(555)555-1234", \ "last_name": "Brown", \ "active": "true", \ "middle_name": "Dell", \ "time_zone": "PST", \ "name": "Jane Brown", \ "household": "4", \ "user": "c3d35d82c37122005871d44d81d3ae91", \ "primary": "false" \ }" --user "username":"password" { "result": "0f5c13addb93230057c3fd441d9619b8" }