---
sourceDocument: Yokohama-API-Referenz
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/de-DE/yokohama/api-reference

 Release :

    - yokohama

ft:locale :

    - de-DE

ft:publication_title :

    - Yokohama-API-Referenz

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# JSON-Datenabruf-API

# JSON-Datenabruf-API {#ariaid-title1}

* Freigeben Version: Yokohama
* 
* Aktualisiert 30. Januar 2025
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 2 Minuten Lesedauer

Daten durch Ausgabe einer HTTPS-GET-Anforderung an die Instanz abfragen.

Standardmäßig wird eine GET-Anforderung als GET-Funktion interpretiert, wenn eine sysparm_sys_idParameter ist vorhanden. Andernfalls wird es als getRecords-Funktion interpretiert. Sie können auch einen URL-Parameter angeben sysparm_action=get. Abfrageantworten werden immer durch einen Datensatz-Hash von Datensätzen gekapselt, wobei die Werte jedes einzelnen Datensatzes selbst nach Feldname gehasht werden.

## Anzeigewert für Referenzvariablen zurückgeben

Wenn Sie einen Datensatz aus einer Funktion „GET" oder „getRecords" abrufen, werden alle diesem Datensatz zugeordneten Felder zurückgegeben. Die Felder sind häufig Referenzfelder, die einen enthalten `sys_ID `Für eine andere Tabelle. Das Verhalten des Basissystems besteht darin, zurückzugeben `sys_ID `Wert für diese Felder. Um den Anzeigewert für das Feld zurückzugeben, verwenden Sie eine der folgenden Optionen:

* Fügen Sie den Systemeigenschaften die Eigenschaft Glide.JSON.return_DisplayValue hinzu, und jede JSON-Anforderung gibt einen Anzeigewert für ein Referenzfeld zurück.
* Fügen Sie den Parameter hinzu displayvalue=trueAn die JSON-Anforderungs-URL und JSON-Anforderungen mit diesem Parameter geben einen Anzeigewert anstelle von zurück `sys_ID `Für ein Referenzfeld. Die JSON-URL würde folgendermaßen aussehen:

      https://<instance name>.service-now.com/incident.do?JSON&sysparm_action=getRecords&sysparm_query=active=true^category=hardware&displayvalue=true

* Fügen Sie den Parameter hinzu displayvalue=allAn die JSON-Anforderungs-URL und JSON-Anforderungen mit diesem Parameter geben einen Anzeigewert und zurück `sys_ID `Für ein Referenzfeld. Dem Antwortelementnamen für das Feld „Anzeigewert" wird vorangestellt `dv_ `, Beispiel `dv_caller_ID `.
{#c_DataRetrievalAPI__ul_xjv_42j_bp}

## Variablen abrufen

Verwenden Sie displayvariablesAbfrageparameter, um ein Array von Variablen zurückzugeben, die einer zugeordnet sind ServicekatalogElementdatensatz. Um Variablen abzurufen, fügen Sie den Parameter hinzu displayvariables=trueAn die JSON-Anforderungs-URL. Beispiel: Hier ist eine URL zum Abrufen eines Datensatzes im JSON-Format, der Folgendes enthält ServicekatalogVariablen:  

    https://<your-instance>.servicenow.com/sc_req_item.do?JSONv2&sysparm_action=getRecords&sysparm_query=sys_id=5018da81742bd410f8771974894916fe&displayvariables=true

Hier ist die Beispielantwort, die einen mehrzeiligen Variablensatz aus dem Datensatz anzeigt:

    {
       "records":[
          {
             ...
             "variables":[
                {
                   "display_value":[
                      {
                         "quantity":"1",
                         "color":"Black",
                         "device_type":"Apple iPhone 8",
                         "storage":"64GB"
                      },
                      {
                         "quantity":"1",
                         "color":"Black",
                         "device_type":"Apple iPhone 8",
                         "storage":"64GB"
                      }
                   ],
                   "columns_meta":[
                      {
                         "name":"device_type",
                         "label":"Device Type",
                         "id":"da7d3f3241411300964ff05369414eca",
                         "type":5,
                         "order":"0"
                      },
                      {
                         "name":"storage",
                         "label":"Storage",
                         "id":"691e337241411300964ff05369414e31",
                         "type":5,
                         "order":"1"
                      },
                      {
                         "name":"color",
                         "label":"Color",
                         "id":"e89fb77241411300964ff05369414e74",
                         "type":5,
                         "order":"2"
                      },
                      {
                         "name":"quantity",
                         "label":"Quantity",
                         "id":"2d5f737241411300964ff05369414eaf",
                         "type":5,
                         "order":"3"
                      }
                   ],
                   "max_rows":50,
                   "name":"mobile_devices_set",
                   "id":"e84d3f3241411300964ff05369414e3e",
                   "type":"one_to_many",
                   "value":[
                      {
                         "quantity":"1",
                         "color":"black",
                         "device_type":"iphone8",
                         "storage":"64GB"
                      },
                      {
                         "quantity":"1",
                         "color":"black",
                         "device_type":"iphone8",
                         "storage":"64GB"
                      }
                   ],
                   "row_count":2
                },
                {
                   "question_text":"Department",
                   "name":"department",
                   "type":8,
                   "value":"Development",
                   "order":100
                },
                {
                   "question_text":"Who is this request for?",
                   "name":"requested_for",
                   "type":8,
                   "value":"System Administrator",
                   "order":100
                },
                {
                   "question_text":"When do you need this?",
                   "name":"needed_by",
                   "type":5,
                   "value":"Today",
                   "order":200
                },
                {
                   "question_text":"Business Justification",
                   "name":"business_justification",
                   "type":2,
                   "value":"Example justification",
                   "order":200
                }
             ],
           ...
          }
       ]
    }

Die Schlüssel in der Antwort sind wie folgt definiert:  
{#c_DataRetrievalAPI__table_ahh_p3v_dnb__entry__2}

| Key | Beschreibung |
|-|-|
| Display_value | Mehrzeilige Variable legt den Anzeigewert der Frage fest. Wird nur mit mehrzeiligen Variablensätzen zurückgegeben. |
| Columns_Meta | Array von Metadaten des mehrzeiligen Variablensatzes, z. B. sys_ID und Name des Felds. Wird nur zurückgegeben, wenn die Variable mehrere Felder enthält. |
| max_rows | Maximal zulässige Zeilen im mehrzeiligen Variablensatz. Wird nur mit mehrzeiligen Variablensätzen zurückgegeben. |
| name | Fragename. |
| ID | SYS_ID des mehrzeiligen Variablensatzes. Wird nur mit mehrzeiligen Variablensätzen zurückgegeben. |
| Typ | Typ der Frage. |
| Wert | Fragenwert. |
| row_count | Aktuelle Anzahl der Zeilen im mehrzeiligen Variablensatz. Wird nur mit mehrzeiligen Variablensätzen zurückgegeben. |
| Question_Text | Fragenbezeichnung. Wird nur mit einzeiligen Variablensätzen zurückgegeben. |
| Reihenfolge | Reihenfolge der Frage. |
[ ]

{#c_DataRetrievalAPI__table_ahh_p3v_dnb}

## Steuert die Reihenfolge der Datensätze

Sie können die Reihenfolge steuern, in der Datensätze in der JSON-Antwort angezeigt werden. Verwenden Sie zum Festlegen einer Reihenfolge SORTIEREN NACH Oder ORDERBYDESC Klauseln in der URL-codierten Abfrage. Beispiel:

    sysparm_query=active=true^ORDERBYnumber^ORDERBYDESCcategory

Filtert alle aktiven Datensätze und ordnet die Ergebnisse zuerst in aufsteigender Reihenfolge nach Zahl und dann in absteigender Reihenfolge nach Kategorie an. Weitere Informationen finden Sie unter [Codierte Abfragezeichenfolgen](https://www.servicenow.com/docs/access?context=c_EncodedQueryStrings&version=yokohama&pubname=yokohama-platform-user-interface&ft:locale=en-US).

## GetKeys

Rufen Sie ab `sys_ID `Von mehreren Datensätzen, indem eine codierte Abfragezeichenfolge in angegeben wird sysparm_queryParameter.

    https://<instance name>.service-now.com/incident.do?JSONv2&sysparm_action=getKeys&sysparm_query=active=true^category=hardware

## get

Rufen Sie einen Datensatz direkt ab, indem Sie angeben `sys_ID `In einem sysparm_sys_idParameter.

    https://<instance name>.service-now.com/incident.do?JSONv2&sysparm_sys_id=9d385017c611228701d22104cc95c371

Optional können Sie auch angeben sysparm_actionParameter:

    https://<instance name>.service-now.com/incident.do?JSONv2&sysparm_action=get&sysparm_sys_id=9d385017c611228701d22104cc95c371

## GetRecords

Rufen Sie alle Datensätze ab, indem Sie eine codierte Abfragezeichenfolge in angeben sysparm_queryParameter.

    https://<instance name>.service-now.com/incident.do?JSONv2&sysparm_action=getRecords&sysparm_query=active=true^category=hardware


