Aktionsparameter

  • Freigeben Version: Washingtondc
  • Aktualisiert 1. Februar 2024
  • 2 Minuten Lesedauer

    • Aktionsparameter unterscheiden sich von Datenparametern, da sie angeben, welche Aktion ausgeführt werden soll, wenn der JSON-Objektparameter Teil einer HTTP-GET- oder POST-Anforderung ist.

    Die Parameter können auch als Feld im bereitgestellten JSON-Objekt angegeben werden. Sie lösen bei sysparm_action eine Aktion aus, oder filtern bei sysparm_query die Ergebnisse einer Aktualisierung oder Abfrage.

    sysparm_action

    Im Folgenden finden Sie die gültigen Werte für sysparm_action und die entsprechende Aktion, die durch die API ausgelöst wird.
    Tabelle : 1. Datenabruf
    Methodenübersicht Beschreibung
    getKeys Fragt die Zieltabelle mit einer codierten Abfragezeichenfolge ab, und gibt eine durch Kommas getrennte Liste von sys_id-Werten zurück.
    getRecords Fragt die Zieltabelle mit einer codierten Abfragezeichenfolge ab, und gibt alle übereinstimmenden Datensätze und ihre Felder zurück.
    get Fragt einen einzelnen Datensatz aus der Zieltabelle ab, indem sys_id im URL-Parameter sysparm_sys_id angegeben wird, und gibt den Datensatz und seine Felder zurück.
    Tabelle : 2. Datenänderung
    Methodenübersicht Beschreibung
    insert Erstellt einen oder mehrere neue Datensätze für die in der URL angegebene Tabelle.
    insertMultiple Erstellt mehrere neue Datensätze für die in der URL angegebene Tabelle.
    update Aktualisiert vorhandene Datensätze in der Zieltabelle in der URL, gefiltert nach einer codierten Abfragezeichenfolge.
    deleteRecord Löscht einen Datensatz aus der in der URL angegebenen Tabelle, indem dessen Datensatz sys_id im URL-Parameter sysparm_sys_id angegeben wird.
    deleteMultiple Löscht mehrere Datensätze aus der in der URL angegebenen Tabelle, gefiltert nach einer codierten Abfragezeichenfolge.

    sysparm_query

    Geben Sie eine codierte Abfragezeichenfolge an, die in den Werten get, getRecords, update oder deleteMultiplesysparm_action verwendet werden soll.

    sysparm_view

    Gibt eine Formularansicht an, um die Rückgabewerte für die Aufrufe der Funktionen „get“ und „getRecords“ anzupassen. Bei Verwendung einer Ansicht gibt die Abfrage nur die in der Ansicht definierten Felder zurück, einschließlich der referenzierten Werte. Wenn kein Ansichtsname vorhanden ist, oder wenn der Ansichtsname nicht gültig ist, gibt die Abfrage alle Feldnamen zurück, die im Dictionary als aktiv markiert sind.

    sysparm_sys_id

    Gibt eine Ziel-sys_id während eines Aufrufs der Funktion „get“ oder „delete“ (Wert sysparm_action) an.

    sysparm_record_count

    Gibt einen ganzzahligen Wert an, um die Anzahl der für diese Anforderung abgerufenen Datensätze zu begrenzen. Beachten Sie, dass dieser Wert durch die Systemeigenschaft glide.processor.json.row_limit begrenzt wird.

    displayvalue

    Ruft den Anzeigewert eines Referenzfelds ab, sofern sich solche im Datensatz befinden. Zum Beispiel kann der Incident-Datensatz ein Feld assigned_to haben, das eine Referenz auf einen Benutzerdatensatz ist. Anstatt die sys_id des Benutzerdatensatzes zu senden, wird der Benutzername gesendet.

    Der Parameter „displayvalue“ kann drei Werte haben: true, false, oder all.
    • true: Alle Referenzfelder zeigen den Anzeigewert anstelle von sys_id an.
    • false (Standard): Alle Referenzfelder zeigen sys_ids an.
    • all: Der Anzeigewert und die sys_id werden angezeigt. Beispielsweise wird das Feld „assignedto“ im Incident-Datensatz als „assigned_to:1234556, dv_assigned_to:Fred Luddy“ zurückgesendet.

    displayvariables

    Setzt diesen boolean Wert auf true während eines Aufrufs der Funktion „get“ oder „getRecords“, um alle mit diesem Datensatz verknüpften Variablen abzurufen.