Automatisierungszentrale-API

  • Freigeben Version: Zurich
  • Aktualisiert 31. Juli 2025
  • 10 Minuten Lesedauer

    • Die Automatisierungszentrale Die API stellt Endpunkte zum Erstellen und Aktualisieren von Daten im Zusammenhang mit Robots, Prozessen und Ausführungsaufträgen bereit. Durch die Nutzung dieser API können Sie Details aus Ihren Automatisierungs-Workflows in integrieren und reflektieren Automatisierungszentrale Dashboard.

    Schlüsselkonzepte der API:
    • Robots: Software-Agents, die Bot-Prozesse ausführen. RPA-Robots können im beaufsichtigten oder unbeaufsichtigten Modus betrieben werden.
    • Prozesse: Instanzen von RPA-Workflows, die auf einem bestimmten Robot ausgeführt werden. Um einen Prozess eindeutig zu identifizieren, müssen sowohl die Prozess-ID als auch die Robot-ID angegeben werden.
    • Ausführungen: Einzelne Aufgaben, die innerhalb eines Prozesses ausgeführt werden, z. B. das Übertragen von Informationen von einer Ressource in eine andere (z. B. das Kopieren von Daten aus E-Mails in eine Tabelle).

    So verwenden Sie die API:

    Sie können die API verwenden, um Daten aus RPA-Tools von Drittanbietern zu senden, einschließlich Robots, Prozessen und Ausführungen Automatisierungszentrale.

    Empfohlener Workflow:
    1. Senden Sie die Robot-Daten.
    2. Senden Sie die Prozessdaten, die mit dem gesendeten Robot verknüpft sind.
    3. Senden Sie Ausführungsdaten, die auf den entsprechenden Robot und Prozess verweisen.
      Hinweis:
      Ausführungsdaten ohne zugehörigen Robot und Prozess wurden bereits in erfasst Automatisierungszentrale Wird nicht im Dashboard angezeigt.
    Zusätzliche Informationen:
    • Ereignisaufbewahrung: Mit dieser API erstellte Ereignisse werden nach 14 Tagen automatisch aus Ihrer Instanz entfernt (Standardeinstellung).
    • Datensatzgrenzwerte: Jeder API-Aufruf kann maximal 2.000 Datensätze verarbeiten. Dieser Grenzwert kann nicht geändert werden.
    • Ereignislöschung: Diese API unterstützt das Löschen von Ereignissen nicht.

    Diese API erfordert Automatisierungszentrale Plugin muss aktiv sein und erfordert, dass der Anwender entweder über die Rolle sn_as.automation_technical_user oder sn_ac.automation_admin verfügt.

    Automatisierungszentrale – POST /sn_ac/Automation/rpa

    Erstellt Robot-, Prozess- und Ausführungsereignisse.

    Diese Ereignisse bieten Prozessautomatisierung. Sie werden in den Dashboards „Übersicht“ und „Ausführungsautomatisierungszentrum“ angezeigt, um die Ausgabe mehrerer RPA-Lieferanten zu messen und zu überwachen.

    URL-Format

    Versionierte URL: /api/sn_ac/{api_Version}/Automation/rpa

    Standard-URL: /api/sn_ac/v1/Automation/rpa

    Hinweis:
    Verfügbare Versionen werden in angegeben REST API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf der Formular „geskripteter REST-Service“ .

    Unterstützte Anforderungsparameter

    Tabelle : 1. Pfadparameter
    Name Beschreibung
    api_version Optional. Version des Endpunkts, auf den zugegriffen werden soll. 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
    Keine
    Tabelle : 3. Anforderungstextparameter (XML oder JSON)
    Name Beschreibung
    Abteilungsname Nur Prozess- und Robot-Ereignistypen. Name der Abteilung, zu der das Ereignis gehört.
    Dieser Wert wird je nach Ereignistyp in den folgenden Tabellen gespeichert:
    • Prozess: Feld „Abteilung“ in der Tabelle „Basis-Bot-Prozess“ [cmdb_ci_Base_rpa_Process].
    • Robot: Abteilungsfeld in der Tabelle „Basis-Robot“ [cmdb_ci_Base_rpa_Robot].

    Datentyp: Zeichenfolge
    domainId SYS_ID der Domäne, zu der das Ereignis gehört.
    Dieser Wert wird je nach Ereignistyp in den folgenden Tabellen gespeichert:
    • Ausführung: Feld „sys_Domain“ in der Tabelle „Automatisierungsausführung“ [sn_ac_Automation_Execution].
    • Prozess: Feld „sys_Domain“ in der Tabelle „Basis-Bot-Prozess“ [cmdb_ci_Base_rpa_Process].
    • Robot: Feld „sys_Domain“ in der Tabelle „Base Robot“ [cmdb_ci_Base_rpa_Robot].

    Datentyp: Zeichenfolge
    endtime Nur Ausführungsereignistyp. Endzeit der Ausführung. Dieser Wert wird im Feld end_time in der Tabelle Automatisierungsausführung [sn_ac_Automation_Execution] gespeichert.

    FORMAT: JJJJ-MM-TT HH:MM:SS

    Datentyp: Zeichenfolge
    Umgebung Nur Ausführungsereignistyp. Umgebung der Ausführung, z. B. eine URL. Dieser Wert wird im Umgebungsfeld in der Tabelle „Automatisierungsausführung“ [sn_ac_Automation_Execution] gespeichert.
    Hinweis:
    Dieser Wert wird nicht von verwendet ServiceNow Instanz und kann jeden Wert enthalten, der für Ihre Implementierung erforderlich ist.

    Datentyp: Zeichenfolge
    errorMessage Nur Ausführungsereignistyp. Name des Fehlermeldungsprotokolls. Dieser Wert wird im Nachrichtenfeld in der Tabelle „Automatisierungsausführung“ [sn_ac_Automation_Execution] gespeichert.

    Datentyp: Zeichenfolge
    eventName Erforderlich. Name des Ereignistyps. Dieser Wert bestimmt den Typ des zu verarbeitenden Ereignisses.
    Gültige Werte (Groß-/Kleinschreibung beachten):
    • Ausführung
    • process
    • Robot

    Datentyp: Zeichenfolge
    id Erforderlich. Eindeutiger numerischer Bezeichner des zugehörigen Ereignisses.
    Dieser Wert wird je nach Ereignistyp in den folgenden Tabellen gespeichert:
    • Ausführung: Feld Automation_Execution_ID in der Tabelle „Automatisierungsausführung“ [sn_ac_Automation_Execution].
    • Prozess: Feld Correlation_ID in der Tabelle „Basis-Bot-Prozess“ [cmdb_ci_Base_rpa_Process].
    • Robot: Feld Correlation_ID in der Tabelle „Base Robot“ [cmdb_ci_Base_rpa_Robot].

    Datentyp: Zahl (Ganzzahl)
    name Nur Prozess- und Robot-Ereignistypen. Erforderlich. Name des Events.
    Dieser Wert wird je nach Ereignistyp in den folgenden Tabellen gespeichert:
    • Prozess: Namensfeld in der Tabelle „Basis-Bot-Prozess“ [cmdb_ci_Base_rpa_Process].
    • Robot: Namensfeld in der Tabelle „Base Robot“ [cmdb_ci_Base_rpa_Robot].

    Datentyp: Zeichenfolge
    Priorität Nur Ausführungsereignistyp. Priorität der Ausführung.
    Gültige Werte (Groß-/Kleinschreibung beachten):
    • Kritisch
    • Hoch
    • Mittel 
    • Niedrig
    Dieser Wert wird im Prioritätsfeld in der Tabelle „Automatisierungsausführung“ [sn_ac_Automation_Execution] gespeichert.

    Datentyp: Zeichenfolge

    Standard: Keine: Wird im Dashboard nicht angezeigt.
    processId Nur Ausführungsereignistyp. Erforderlich. Eindeutiger Bezeichner des Prozesses, für den die Ausführung ausgeführt werden soll. Dieser Wert befindet sich im Feld Correlation_ID des entsprechenden Prozessdatensatzes in der Tabelle „Base Bot Process“ [cmdb_ci_Base_rpa_Process].

    Dieser Wert wird im Feld Automatisierung in der Tabelle Automatisierungsausführung [sn_ac_Automation_Execution] gespeichert.

    Datentyp: Zeichenfolge
    RobotId Nur Ausführungsereignistyp. Erforderlich. Eindeutiger Bezeichner des Robot, für den die Ausführung ausgeführt werden soll. Dieser Wert befindet sich im Feld Correlation_ID des entsprechenden Robot-Datensatzes in der Tabelle „Base Robot“ [cmdb_ci_Base_rpa_Robot].

    Dieser Wert wird im Robot-Feld in der Tabelle „Automatisierungsausführung“ [sn_ac_Automation_Execution] gespeichert.

    Datentyp: Zeichenfolge
    Quelle Erforderlich. Quelle, zu der das Ereignis gehört, z. B. „servicenow_rpa“. Dieser Wert befindet sich im Feld internal_Name der Tabelle „Automatisierungsquelle“ [sn_ac_Automation_Source].
    Dieser Wert wird je nach Ereignistyp in den folgenden Tabellen gespeichert:
    • Ausführung: Quellfeld in der Tabelle „Automatisierungsausführung“ [sn_ac_Automation_Execution].
    • Prozess: Quellfeld in der Tabelle „Basis-Bot-Prozess“ [cmdb_ci_Base_rpa_Process].
    • Robot: Quellfeld in der Tabelle „Base Robot“ [cmdb_ci_Base_rpa_Robot].

    Datentyp: Zeichenfolge
    starttime Nur Ausführungsereignistyp. Startzeit der Ausführung. Dieser Wert wird im Feld Start_time in der Tabelle Automatisierungsausführung [sn_ac_Automation_Execution] gespeichert.

    Datentyp: Zeichenfolge

    FORMAT: JJJJ-MM-TT HH:MM:SS
    Status Nur Robot- und Ausführungsereignistypen. Status des zugehörigen Ereignisses.
    Gültige Werte für Robot (Groß-/Kleinschreibung beachten):
    • Abgebrochen
    • Abgeschlossen
    • Fehler
    • In der Warteschlange
    • Wird ausgeführt
    Standard: In Warteschlange
    Mögliche Werte für die Ausführung (Groß-/Kleinschreibung beachten):
    • Verfügbar
    • Beschäftigt
    • Verbindung getrennt
    • Neu
    • Reaktionsfähig
    Standard: Neu
    Dieser Wert wird je nach Ereignistyp in den folgenden Tabellen gespeichert:
    • Ausführung: Feld „status“ in der Tabelle „Automatisierungsausführung“ [sn_ac_Automation_Execution].
    • Robot: Feld Robot_State in der Tabelle „Base Robot“ [cmdb_ci_Base_rpa_Robot].

    Datentyp: Zeichenfolge
    status Nur Prozessereignistyp. Erforderlich. Status des Prozesses.
    Mögliche Werte (Groß-/Kleinschreibung beachten):
    • Build
    • In Wartung
    • In Gebrauch
    • Deaktiviert
    Dieser Wert wird im Feld Life_Cycle_stage_Status in der Tabelle „Base Bot-Prozess“ [cmdb_ci_Base_rpa_Process] gespeichert.

    Datentyp: Zeichenfolge
    TriggeredBy Nur Ausführungsereignistyp. Auslöserquelle der Ausführung. Dieser Wert wird im Feld Trigger_by in der Tabelle Automatisierungsausführung [sn_ac_Automation_Execution] gespeichert.
    Hinweis:
    Dieser Wert wird nicht von verwendet ServiceNow Instanz und kann jeden Wert enthalten, der für Ihre Implementierung erforderlich ist.

    Datentyp: Zeichenfolge
    type Nur Prozess- und Robot-Ereignistypen. Erforderlich für Prozess, optional für Robot. Typ der auszuführenden Verarbeitung.
    Gültige Werte (Groß-/Kleinschreibung beachten):
    • Attended
    • Unattended
    Dieser Wert wird je nach Ereignistyp in den folgenden Tabellen gespeichert:
    • Prozess: Feld Process_type in der Tabelle „Basis-Bot-Prozess“ [cmdb_ci_Base_rpa_Process].
    • Robot: Feld Robot_type in der Tabelle „Base Robot“ [cmdb_ci_Base_rpa_Robot].

    Datentyp: Zeichenfolge

    Standard: Unbeaufsichtigt für Robot
    Version Nur Robot-Ereignistyp. Version des Robot.

    Dieser Wert wird im Feld „Version“ in der Tabelle „Base Robot“ [cmdb_ci_Base_rpa_Robot] gespeichert.

    Datentyp: Zeichenfolge

    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 .

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

    Standard: application/json
    Inhaltstyp Datenformat des Anforderungstexts. 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 REST API-HTTP-Antwortcodes .

    Tabelle : 6. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    400 Fehler. Die Anforderung wurde abgelehnt, da Pflichtfelder fehlen oder die Anforderung ungültige Werte enthält. Die zugehörige Fehlermeldung beschreibt den Grund für den Fehler.

    Parameter des Antwort-Haupttexts

    Name Beschreibung
    Ergebnis Leer, wenn die Anforderung erfolgreich ist. Bei Fehlern werden zusätzliche Informationen bereitgestellt.

    Datentyp: Objekt

    "result": {
  "fields": {
    "<record_number>": [Array]
  }
  "reason": "String"
}
    Wenn beispielsweise in den Datensätzen 1, 2 und 3 ein Pflichtfeld fehlt, wird eine ähnliche Nachricht wie die folgende zurückgegeben:
    {
  "result": {
    "fields": {
      "1": [
        "id"
      ],
      "2": [
        "status"
      ],
      "3": [
        "name"
      ]
    },
    "reason": "We are not able to process the data as following records have insufficient data"
  }
}

    cURL-Anforderung

    Das folgende Codebeispiel zeigt, wie drei Robot-Ereignistypdatensätze veröffentlicht werden.

    curl "https://instance.servicenow.com/api/sn_ac/automation/rpa" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
  records: [{
    id: 8001,
    name: "Quotes system Automation Robot",
    state: "Available",
    status: "In Use",
    version: 5.6,
    departmentName: "Customer Support",
    type: "Unattended",
    source: "servicenow_rpa",
    eventName: "robot"
  },
  {
    id: 8002,
    name: "Invoice Matching Robot",
    state: "Responsive",
    status: "In Maintenance",
    version: 3,
    departmentName: "HR",
    type: "Unattended",
    source: "servicenow_rpa",
    eventName: "robot"
  },
  {
    id: 8003,
    name: "Data Reconciliation Robot",
    state: "Busy",
    status: "Retired",
    version: 2,
    departmentName: "Finance",
    type: "Unattended",
    source: "servicenow_rpa",
    eventName: "robot"
  }]
} "\
--user "username":"password"

    Dieser Endpunkt gibt nur bei Erfolg einen HTTP-Statuscode und bei einem Fehler einen HTTP-Statuscode und eine Fehlermeldung zurück.

    None

    cURL-Anforderung

    Das folgende Codebeispiel zeigt, wie drei Datensätze vom Typ „Prozessereignis“ veröffentlicht werden.

    curl "https://instance.servicenow.com/api/sn_ac/automation/rpa" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
  records: [{
    id: 9001,
    name: "RPA Execution Process",
    status: "In Maintenance",
    type: "Attended",
    departmentName: "Customer Support",
    source: "servicenow_rpa",
    eventName: "process"
  },
  {
    id: 9002,
    name: "Customer Onboarding",
    status: "In Use",
    type: "Attended",
    departmentName: "Finance",
    source: "servicenow_rpa",
    eventName: "process"
  },
  {
    id: 9003,
    name: "Data Reconciliation",
    status: "Retired",
    type: "Unattended",
    departmentName: "HR",
    source: "servicenow_rpa",
    eventName: "process"
  }]
}" \
--user "username":"password"

    Dieser Endpunkt gibt nur bei Erfolg einen HTTP-Statuscode und bei einem Fehler einen HTTP-Statuscode und eine Fehlermeldung zurück.

    None

    cURL-Anforderung

    Das folgende Codebeispiel zeigt, wie drei Datensätze vom Typ „Ausführungsereignis“ veröffentlicht werden.

    curl "https://instance.servicenow.com/api/sn_ac/automation/rpa" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
  records: [{
    id: 7001,
    name: "Customer Onboarding",
    starttime: "2022-03-18 00:49:13",
    endtime: "2022-03-20 00:58:03",
    state: "Running",
    priority: "Critical",
    environment: "system",
    triggeredBy: "Schedule",
    processId: 9001,
    robotId: 8001,
    source: "servicenow_rpa",
    eventName: "execution"
  },
  {
    id: 7002,
    name: "Data Reconciliation",
    starttime: "2022-04-30 00:19:11",
    endtime: "2022-05-02 00:41:35",
    state: "Error",
    priority: "Low",
    environment: "system",
    triggeredBy: "API",
    processId: 9002,
    robotId: 8002,
    source: "servicenow_rpa",
    eventName: "execution"
  },
  {
    id: 7003,
    name: "Customer Onboarding",
    starttime: "2022-01-22 02:38:53",
    endtime: "2022-01-23 02:50:44",
    state: "Queued",
    priority: "Moderate",
    environment: "system",
    triggeredBy: "Schedule",
    processId: 9003,
    robotId: 8003,
    source: "servicenow_rpa",
    eventName: "execution"
  }]
} "\
--user "username":"password"

    Dieser Endpunkt gibt nur bei Erfolg einen HTTP-Statuscode und bei einem Fehler einen HTTP-Statuscode und eine Fehlermeldung zurück.

    None

    cURL-Anforderung

    Das folgende Codebeispiel zeigt, wie ein Prozess erstellt oder aktualisiert wird. Sie erstellen einen Prozess, indem Sie alle obligatorischen Parameter übergeben, damit ein Prozess zusammen mit ausgeführt werden kann eventNameAuf „Prozess“ festlegen. Die obligatorischen Parameter, die zum Erstellen eines Prozesses erforderlich sind, sind: id, type, status, name, Und source.

    curl "https://instance.servicenow.com/api/sn_ac/automation/rpa" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
records: [{
id: 9001,
name: "RPA Execution Process",
status: "In Maintenance",
type: "Attended",
departmentName: "Customer Support",
source: "servicenow_rpa",
eventName: "process"
}]
} "\
--user "username":"password"

    Dieser Endpunkt gibt nur bei Erfolg einen HTTP-Statuscode und bei einem Fehler einen HTTP-Statuscode und eine Fehlermeldung zurück.

    None

    cURL-Anforderung

    Das folgende Codebeispiel zeigt, wie ein Prozess veröffentlicht wird. Sie können einen Prozess veröffentlichen, indem Sie übergeben statusParameter auf „veröffentlicht“ festgelegt.

    curl "https://instance.servicenow.com/api/sn_ac/automation/rpa" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
records: [{
id: 9002,
name: "RPA Execution Process",
status: "Published",
type: "Attended",
departmentName: "Customer Support",
source: "servicenow_rpa",
eventName: "process"
}]
} "\
--user "username":"password"

    Dieser Endpunkt gibt nur bei Erfolg einen HTTP-Statuscode und bei einem Fehler einen HTTP-Statuscode und eine Fehlermeldung zurück.

    None

    cURL-Anforderung

    Das folgende Codebeispiel zeigt, wie ein Robot erstellt oder aktualisiert wird. Sie erstellen einen Robot, indem Sie alle obligatorischen Parameter für einen Robot zusammen mit übergeben eventNameAuf „Robot“ festlegen. Die obligatorischen Parameter, die zum Erstellen eines Robot erforderlich sind, sind: id, status, name, Und source.

    curl "https://instance.servicenow.com/api/sn_ac/automation/rpa" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
records: [{
id: 8001,
name: "Quotes system Automation Robot",
state: "Available",
status: "In Use",
version: 5.6,
departmentName: "Customer Support",
type: "Unattended",
source: "servicenow_rpa",
eventName: "robot"
} "\
--user "username":"password"

    Dieser Endpunkt gibt nur bei Erfolg einen HTTP-Statuscode und bei einem Fehler einen HTTP-Statuscode und eine Fehlermeldung zurück.

    None

    cURL-Anforderung

    Das folgende Codebeispiel zeigt, wie eine Ausführung erstellt oder aktualisiert wird. Sie erstellen eine Ausführung, indem Sie alle obligatorischen Parameter für eine Ausführung zusammen mit übergeben eventNameAuf „Ausführung“ festlegen. Die obligatorischen Parameter, die zum Erstellen einer Ausführung erforderlich sind, sind: id, processId, robotId, Und source.

    curl "https://instance.servicenow.com/api/sn_ac/automation/rpa" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
records: [{
id: 7001,
name: "Customer Onboarding",
starttime: "2022-03-18 00:49:13",
endtime: "2022-03-20 00:58:03",
state: "Running",
priority: "Critical",
environment: "http://acqa.servicenow.com",
triggeredBy: "Schedule",
processId: 9001,
robotId: 8001,
source: "servicenow_rpa",
eventName: "execution",
errorMessage:"Error due to Inactivity"
}]
} "\
--user "username":"password"

    Dieser Endpunkt gibt nur bei Erfolg einen HTTP-Statuscode und bei einem Fehler einen HTTP-Statuscode und eine Fehlermeldung zurück.

    None