Account-API

Xanadu-API-Referenz

Release

xanadu

ft:locale

de-DE

ft:publication_title

Xanadu-API-Referenz

ft:clusterId

crapiref

bundleId

crapiref

workflow

Creator

Account-API

Freigeben Version: Xanadu

Aktualisiert 1. August 2024

12 Minuten Lesedauer

Die Account- API bietet Endpunkte zum Abrufen und Aktualisieren von Kundenservice-Management (CSM) -Account-Datensätzen.

Darüber hinaus können Sie beim Erstellen eines Accounts neue Social Media-Profildatensätze generieren.

Die Account -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.

Account: GET /now/account

Ruft einen angegebenen Satz von Kundenservice-Management (CSM) -Accounts ab.

URL-Format

URL mit Versionsnummer: /api/now/{api_version}/account

Standard-URL: /api/now/account

Unterstützte Anforderungsparameter

Tabelle : 1. Pfadparameter
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 : 2. Abfrageparameter
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 : 3. Anforderungstextparameter (XML oder JSON)
Element	Beschreibung
Keine

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.

Tabelle : 4. Anforderungskopfzeilen
Kopfzeile	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json

Tabelle : 5. Antwortkopfzeilen
Kopfzeile	Beschreibung
Keine

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-Antwortcodesder REST-API.

Tabelle : 6. Statuscodes
Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
500	Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

Parameter des Antworttexts (JSON oder XML)


Parameter	Beschreibung
account_code	Eindeutige Kombination von Werten, die von einer Anwendung zum Identifizieren von Budgetprognosen und Budgetplänen verwendet werden. Datentyp: Zeichenfolge Maximale Länge: 255
account_parent	Sys_id des übergeordneten Accounts dieses Accounts. Befindet sich in der Tabelle „Account“ [customer_account]. Datentyp: Zeichenfolge
account_path	Pfad vom übergeordneten zu den untergeordneten Accounts in der Accounthierarchie. Datentyp: Zeichenfolge Maximale Länge: 255
active_escalation	Sys_id der aktiven Eskalation, die dem Account zugeordnet ist. Befindet sich in der Tabelle „Eskalation“ [sn_customerservice_escalation]. Datentyp: Zeichenfolge
Apple_icon	Symbol für iPhone-Homepage-Lesezeichen. Datentyp: Bild
„banner_image“	Bannerbild, das im Kundenportal angezeigt wird. Datentyp: Bild
„banner_image_light“	Kleines Bannerbild. Datentyp: Bild
„banner_text“	Bannertext, der im Kundenportal angezeigt wird. Datentyp: Zeichenfolge Maximale Länge: 4.000
city	Stadt, in der das diesem Account zugeordnete Unternehmen ansässig ist. Datentyp: Zeichenfolge Maximale Länge: 50
Kontakt	Sys_id eines Kontaktdatensatzes, der diesem Account zugeordnet ist. Befindet sich in der Tabelle „Benutzer“ [sys_user]. Datentyp: Zeichenfolge
country	Land, in dem das diesem Account zugeordnete Unternehmen ansässig ist. Datentyp: Zeichenfolge Maximale Länge: 40 Standard: USA
Kunde	Kennzeichnung, die angibt, ob es sich bei dem Account um einen Kunden-Account oder um einen Partner-Account handelt. Mögliche Werte: true: Kunden-Account false: Partner-Account Datentyp: Boolesch Standardwert: false
Rabatt	Rabatt, der dem Account bei Käufen gewährt wird. Datentyp: Zahl Maximale Länge: 15
fax_phone	Primäre Faxnummer des Unternehmens, das diesem Account zugeordnet ist. Datentyp: Zeichenfolge Maximale Länge: 40
fiscal_year	Geschäftsjahr für das Unternehmen, das dem Account zugeordnet ist. Datentyp: Zeichenfolge
lat_long_error	Differenz des tatsächlichen Standorts im Vergleich zu den Breiten- und Längengradinformationen. Datentyp: Zeichenfolge Maximale Länge: 1.000
latitude	Breitengrad des Unternehmens, das diesem Account zugeordnet ist. Datentyp: Zahl (Gleitkommazahl) Maximale Länge: 40
longitude	Längengrad des Unternehmens, das diesem Account zugeordnet ist. Datentyp: Zahl (Gleitkommazahl) Maximale Länge: 40
manufacturer	Kennzeichnung, die angibt, ob das diesem Account zugeordnete Unternehmen Waren herstellt. Mögliche Werte: true: Stellt Waren her „falsch“: Stellt keine Waren her Datentyp: Boolesch Standardwert: false
market_cap	Marktwert der börsennotierten Aktien des zugehörigen Unternehmens. Datentyp: Zahl (Währung) Maximale Länge: 20
name	Name des Unternehmens, das diesem Account zugeordnet ist. Datentyp: Zeichenfolge Maximale Länge: 80
Notizen	Zusätzliche Informationen zum Unternehmen. Datentyp: Zeichenfolge Maximale Länge: 4.000
num_employees	Anzahl der im Unternehmen beschäftigten Personen. Datentyp: Zahl (Ganzzahl) Maximale Länge: 40
Nummer	Nummer, die diesen Account identifiziert. Datentyp: Zeichenfolge Maximale Länge: 40
übergeordnet	Sys_id des übergeordneten Accounts dieses Accounts. Befindet sich in der Tabelle „Unternehmen“ [core_company]. Datentyp: Zeichenfolge
Partner	Kennzeichnung, die angibt, ob es sich bei dem Account um einen Partneraccount oder einen Kundenaccount handelt. Mögliche Werte: true: Partner-Account „falsch“: Kunden-Account Datentyp: Boolesch Standardwert: false
Telefon	Telefonnummer des Unternehmens. Datentyp: Zeichenfolge
primär	Kennzeichnung, die angibt, ob dies ein primärer Account ist. Mögliche Werte: true: Primärer Account „falsch“: Sekundärer Account Datentyp: Boolesch Standardwert: false
primary_contact	Sys_id des primären Kontakts für den Account. Befindet sich in der Kontakttabelle [customer_contact]. Datentyp: Zeichenfolge
Gewinne	Für dieses Konto eingegebene Gewinninformationen. Datentyp: Zahl (Währung) Maximale Länge: 40
publicly_trading	Kennzeichnung, die angibt, ob das diesem Account zugeordnete Unternehmen börsennotiert ist. Mögliche Werte: true: Öffentlich gehandelt false: Privates Unternehmen Datentyp: Boolesch
rank_tier	Typ des Accounts. Mögliche Werte: Schwarze Liste strategisch taktisch bewertet sonstige Datentyp: Zeichenfolge Maximale Länge: 40
Registrierungscode	Eindeutiger Code, den Kunden verwenden, wenn sie eine Anmeldung im Kundenportal anfordern Dieser Code bietet eine Methode zum Validieren des Kunden im Unternehmen, bevor Zugriff gewährt wird. Datentyp: Zeichenfolge Maximale Länge: 40
Umsätze_pro_Jahr	Umsatz des Unternehmens, das diesem Account zugeordnet ist. Datentyp: Zahl (Währung) Maximale Länge: 20
Staat	Bundesstaat, in dem das Unternehmen ansässig ist. Datentyp: Zeichenfolge Maximale Länge: 40
Stock_Price	Preis der Aktie des Unternehmens. Datentyp: Zeichenfolge Maximale Länge: 40
Stock_Symbol	Aktiensymbol des Unternehmens. Datentyp: Zeichenfolge Maximale Länge: 40
Straße	Straße und Hausnummer des Unternehmens. Datentyp: Zeichenfolge Maximale Länge: 255
sys_class_name	Tabelle, die den zugeordneten Account-Datensatz enthält. Datentyp: Zeichenfolge
sys_created_by	Anwender, der den Account ursprünglich erstellt hat. Datentyp: Zeichenfolge Maximale Länge: 40
sys_created_on	Datum und Uhrzeit der ursprünglichen Erstellung des Accounts. Datentyp: Zeichenfolge
sys_id	Sys_id für den Account-Datensatz. Datentyp: Zeichenfolge
sys_mod_count	Anzahl der Aktualisierungen der Account-Informationen. Datentyp: Zahl (Ganzzahl)
sys_updated_by	Anwender, der die Account-Informationen zuletzt geändert hat. Datentyp: Zeichenfolge Maximale Länge: 40
sys_updated_on	Datum und Uhrzeit der letzten Aktualisierung der Account-Informationen. Datentyp: Zeichenfolge
Thema	Sys_id des von diesem Account verwendeten Kundenportal-Designs. Befindet sich in der Designtabelle [sys_ui_theme]. Datentyp: Zeichenfolge
Lieferant	Kennzeichnung, die angibt, ob das diesem Account zugeordnete Unternehmen ein Lieferant ist. Mögliche Werte: true: Lieferant false: Kein Lieferant Datentyp: Boolesch Standardwert: false
vendor_manager	Liste der sys_ids der Lieferantenmanager für den Account. Befindet sich in der Tabelle „Benutzer“ [sys_user]. Datentyp: Zeichenfolge
vendor_type	Liste der sys_ids des Lieferantentyps, z. B. Anwendungen, Hardware, Services oder Software. Befindet sich in der Tabelle „Lieferantentyp“ [vendor_type]. Datentyp: Zeichenfolge
Website von	URL der Website des Unternehmens Datentyp: Zeichenfolge Maximale Länge: 1.024
Postleitzahl	Postleitzahl des Unternehmens. Datentyp: Zeichenfolge Maximale Länge: 40

cURL-Anforderung

curl "https://instance.servicenow.com/api/now/account?sysparm_limit=2&sysparm_offset=2>;rel="next" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

{
"result": [
  {
   "banner_image_light": "",
   "country": "USA",
   "parent": "",
   "notes": "",
   "stock_symbol": "",
   "discount": "",
   "active_escalation": "",
   "sys_updated_on": "2019-01-03 19:37:55",
   "apple_icon": "",
   "number": "ACCT0000003",
    "sys_updated_by": "admin",
    "fiscal_year": "",
    "sys_created_on": "2018-12-23 05:25:17",
    "contact": "",
    "stock_price": "",
    "state": "",
    "banner_image": "",
    "sys_created_by": "admin",
    "longitude": "",
    "zip": "BR1 3QR",
    "profits": "0",
    "phone": "+44 20 8466 9992",
    "fax_phone": "",
    "name": "Boxeo EMEA",
    "banner_text": "",
    "account_code": "~~~~3",
    "primary": "false",
    "city": "Bromley",
    "latitude": "",
    "sys_class_name": "customer_account",
    "manufacturer": "false",
    "account_parent": "86837a386f0331003b3c498f5d3ee4ca",
    "sys_id": "3eedd08413651200042ab3173244b088",
    "market_cap": "0",
    "num_employees": "",
    "rank_tier": "",
    "street": "18 London Rd",
    "vendor": "false",
    "lat_long_error": "",
    "theme": "",
    "vendor_type": "",
    "website": "",
    "revenue_per_year": "0",
    "publicly_traded": "false",
    "sys_mod_count": "5",
    "sys_tags": "",
    "partner": "false",
    "registration_code": "BOXEO-EMEA",
    "vendor_manager": "",
    "account_path": "~~~~1/~~~~3",
    "primary_contact": "ff66c1254fb81200025ba3618110c76e",
    "customer": "true"
  },
  {
    "banner_image_light": "",
    "country": "USA",
    "parent": "",
    "notes": "",
    "stock_symbol": "",
    "discount": "",
    "active_escalation": "",
    "sys_updated_on": "2019-01-03 19:38:04",
    "apple_icon": "",
    "number": "ACCT0000004",
    "sys_updated_by": "admin",
    "fiscal_year": "",
    "sys_created_on": "2018-12-23 05:19:24",
    "contact": "",
    "stock_price": "",
    "state": "",
    "banner_image": "",
    "sys_created_by": "admin",
    "longitude": "",
    "zip": "V5L 2G4",
    "profits": "0",
    "phone": "+1 604-255-9797",
    "fax_phone": "",
    "name": "Boxeo Canada",
    "banner_text": "",
    "account_code": "~~~~4",
    "primary": "false",
    "city": "Vancouver",
    "latitude": "",
    "sys_class_name": "customer_account",
    "manufacturer": "false",
    "account_parent": "86837a386f0331003b3c498f5d3ee4ca",
    "sys_id": "609cd80413651200042ab3173244b03e",
    "market_cap": "0",
    "num_employees": "",
    "rank_tier": "",
    "street": "1362 Venables St,, BC V5L 2G4, Canada",
    "vendor": "false",
    "lat_long_error": "",
    "theme": "",
    "vendor_type": "",
    "website": "",
    "revenue_per_year": "0",
    "publicly_traded": "false",
    "sys_mod_count": "5",
    "sys_tags": "",
    "partner": "false",
    "registration_code": "BOXEO-CANADA",
    "vendor_manager": "",
    "account_path": "~~~~1/~~~~4",
    "primary_contact": "c07424a54f781200025ba3618110c746",
    "customer": "true"
  }
 ]
}

Account – GET /now/account/{id}

Ruft den angegebenen Account Kundenservice-Management (CSM) ab.