---
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


---

# Now APIServiceklasse: IOS

# Now APIServiceklasse: IOS {#ariaid-title1}

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

Die Now APIService Die Klasse bietet Funktionen, mit denen Sie Anforderungen an einen angegebenen ausführen können ServiceNowREST-API.
{#NowAPIServiceiOSAPI__table_vx2_klw_5pb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| konfigurieren | [Jetzt Servicekonfiguration](https://servicenow-prod.fluidtopics.net/m~vU6ffKznzmlhUz94FBmw#NowServiceConfigurationiOSStruct "Die Jetzt Servicekonfiguration Struktur definiert Konfigurationsinformationen für einen Funktionsservice.") | Servicekonfiguration, die dem Protokoll zugeordnet werden soll. |
[Tabelle : 1. Eigenschaften]

{#NowAPIServiceiOSAPI__table_vx2_klw_5pb}

## NowAPIService -- Daten(für Endpunkt: NowAPIEndpoint, queryItems: \[Zeichenfolge: Zeichenfolge\], httpHeader: \[Zeichenfolge: Zeichenfolge\], Text: Daten, Abschluss: @Escaping (Ergebnis\<DataResponse, jetzt Datenfehler\>) {#ariaid-title2}

Fordert Daten von der angegebenen an ServiceNowREST-API und führt dann den Abschlusshandler aus.
{#NAPIiOS-data_O_A_A_S_O__table_jck_kyp_5pb__entry__3}{#NAPIiOS-data_O_A_A_S_O__mobilesdkiOS-completion_data_dataerror-row}

| Name | Typ | Beschreibung |
|-|-|-|
| Für Endpunkt | [Now APIEndpunkt](https://servicenow-prod.fluidtopics.net/2GC0ZE44BIVAXLC_mGd~yQ#NowAPIEndpointiOSProtocol "Die Now APIEndpunkt das protokoll bietet eine Schnittstelle für den Zugriff auf öffentlich zugängliche ServiceNowREST-APIs.") | Objekt mit ServiceNowREST-API-Endpunkt, auf den zugegriffen werden soll, einschließlich der HTTP-Methode, des relativen Pfads zum Endpunkt, der Pfadparameter und der Angabe, ob eine Authentifizierung erforderlich ist. |
| QueryItems | Array | Optional. Abfrageparameter für den Endpunkt als Schlüssel-Wert-Paare. Standard: Null |
| HTTP-Header | Array | Optional. Anforderungs-HTTP-Header, die vom Endpunkt als Schlüssel-Wert-Paare erforderlich sind. Standard: Null |
| body | Zeichenfolge | Optional. Anforderungstext-Parameter. Standard: Null |
| Abschluss | @Escaping (Result\<DataResponse, NowDataError\>) | Fertigstellungs-Handler, der nach Abschluss des REST-API-Aufrufs ausgeführt werden soll. Rückgabewerte für den Abschlusshandler: * Erfolg: Datenantwort, die die vom REST-API-Aufruf zurückgegebenen Daten enthält. * Fehler: Now DataError * `AccessToken (AccessTokenProviderError)` * AccessTokenProviderError: Fehlercode oder Meldung des Zugriffstoken-Providers. * AccessTokenRetrievalFehlgeschlagen * UserSessionError(_ Fehler: Fehler) Wird ausgelöst, wenn im Zugriffstoken ein Fehler auftritt. * `Anhangvalidierung` Wird ausgelöst, wenn die Validierung eines Anhangs fehlschlägt. * `BadResponse (statusCode: HTTPStatusCode)` * HTTPStatusCode: Statuscode, der von der Instanz empfangen wurde. Wird ausgelöst, wenn eine Anforderung eine unerwartete Antwort zurückgibt * `CannotDecodeModel (DecodingError)` * DecodingError: Decodierungsfehler erkannt. Wird ausgelöst, wenn ein codierbares Modell nicht aus JSON decodiert werden kann. * `CannotDecodeProperty(Typ: Beliebig, von: Zeichenfolge)` * type: Umschlossener Typ, der aus einer Zeichenfolge decodiert werden soll. * from: Zeichenfolge, die für den angegebenen Typ decodiert werden soll. Wird ausgelöst, wenn ein Zeichenfolgenumschlossener Wert nicht aus JSON decodiert werden kann. * `CannotEncodeModel(EncodingError)` * EncodingError: Codierungsfehler erkannt. Wird ausgelöst, wenn ein codierbares Modell nicht in JSON codiert werden kann. * `CannotParseResponse` Wird ausgelöst, wenn eine Antwort von der Instanz nicht im erwarteten Format analysiert werden kann. * `Ungültige URL` Wird ausgelöst, wenn eine URL nicht erstellt werden kann. Beispiel: Wenn die Zeichenfolge Zeichen enthält, die in einer URL unzulässig sind oder eine leere Zeichenfolge ist. * `FehlingAnhangMetadata` Wird ausgelöst, wenn der Header der Metadaten des Anhangs fehlt. * `MissingServiceConfiguration` Wird ausgelöst, wenn eine erwartete Servicekonfiguration fehlt. * `FehlingSysID` Wird ausgelöst, wenn ein erwarteter sys_ID-Parameter fehlt. * `Netzwerk (NetzwerkServicefehler)` * GenericError (Zeichenfolge) * Betrieb abgebrochen * Servicedeaktiviert * Serverfehler (Fehler) * Systemfehler (Fehler) Wird ausgelöst, wenn bei einem Netzwerkservice ein Fehler aufgetreten ist. {#NAPIiOS-data_O_A_A_S_O__NowDataErroriOS-ul-enum} {#NAPIiOS-data_O_A_A_S_O__ul_uzx_thj_ppb} |
[Tabelle : 2. Parameter]

{#NAPIiOS-data_O_A_A_S_O__table_jck_kyp_5pb} {#NAPIiOS-data_O_A_A_S_O__table_kck_kyp_5pb__entry__2}

| Typ | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 3. Rückgaben]

{#NAPIiOS-data_O_A_A_S_O__table_kck_kyp_5pb}  
Das folgende Codebeispiel zeigt, wie diese Funktion aufgerufen wird.

    struct Endpoint: NowAPIEndpoint {
      let httpMethod: HTTPMethod
      let relativePath: String
      let requiresAuthentication: Bool
    }

    /// HTTP request method
    public enum HTTPMethod: CaseIterable {
        case options, get, head, post, put, patch, delete, trace, connect
    }
    let relativePath = "/api/now/account"
    let endPoint = Endpoint(httpMethod: HTTPMethod.get, relativePath: relativePath, requiresAuthentication: true)

    apiService.data(for: endPoint, queryItems: ["name": "abel"], httpHeaders: httpHeaders, body: body.data(using: .utf8)) { [weak self] (result) in
      switch result {
        case .success(let response):
        // Data request successful
        case .failure(let error):
        // Data request failed, return NowDataError
        // .failure(error)
      }
    }

## NowAPIService -- Daten (für Endpunkt: NowAPIEndpoint, queryItems: \[Zeichenfolge: Zeichenfolge\], httpHeader: \[Zeichenfolge: Zeichenfolge\], Textkörper: Daten) asynchrone Auslöse {#ariaid-title3}

Fordert Daten von der angegebenen an ServiceNowREST-API.
{#NAPIiOS-data-async_O_A_A_S_O__table_jck_kyp_5pb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Für Endpunkt | [Now APIEndpunkt](https://servicenow-prod.fluidtopics.net/2GC0ZE44BIVAXLC_mGd~yQ#NowAPIEndpointiOSProtocol "Die Now APIEndpunkt das protokoll bietet eine Schnittstelle für den Zugriff auf öffentlich zugängliche ServiceNowREST-APIs.") | Objekt mit ServiceNowREST-API-Endpunkt t o Zugriff, einschließlich HTTP-Methode, relativem Pfad zum Endpunkt, Pfadparametern und Angabe, ob Authentifizierung erforderlich ist. |
| QueryItems | Array | Optional. Abfrageparameter Für den Endpunkt als Schlüssel/Wert-Paare. Standard: Null |
| HTTP-Header | Array | Optional. Anforderungs-HTTP-Header, die für den Endpunkt als erforderlich sind Schlüssel/Wert-Paare . Standard: Null |
| body | Zeichenfolge | Optional. Anforderungsbod y-Parameter rs. Standard: Null |
[Tabelle : 4. Parameter]

{#NAPIiOS-data-async_O_A_A_S_O__table_jck_kyp_5pb} {#NAPIiOS-data-async_O_A_A_S_O__table_kck_kyp_5pb__entry__2}

| Typ | Beschreibung |
|-|-|
| Datenantwort | Wird zurückgegeben, wenn die Methode erfolgreich ist. Daten aus dem REST-API-Aufruf. |
| Jetzt Datenfehler | Wird ausgelöst, wenn die Methode fehlschlägt. * `AccessToken (AccessTokenProviderError)` * AccessTokenProviderError: Fehlercode oder Meldung des Zugriffstoken-Providers. * AccessTokenRetrievalFehlgeschlagen * UserSessionError(_ Fehler: Fehler) Wird ausgelöst, wenn im Zugriffstoken ein Fehler auftritt. * `Anhangvalidierung` Wird ausgelöst, wenn die Validierung eines Anhangs fehlschlägt. * `BadResponse (statusCode: HTTPStatusCode)` * HTTPStatusCode: Statuscode, der von der Instanz empfangen wurde. Wird ausgelöst, wenn eine Anforderung eine unerwartete Antwort zurückgibt * `CannotDecodeModel (DecodingError)` * DecodingError: Decodierungsfehler erkannt. Wird ausgelöst, wenn ein codierbares Modell nicht aus JSON decodiert werden kann. * `CannotDecodeProperty(Typ: Beliebig, von: Zeichenfolge)` * type: Umschlossener Typ, der aus einer Zeichenfolge decodiert werden soll. * from: Zeichenfolge, die für den angegebenen Typ decodiert werden soll. Wird ausgelöst, wenn ein Zeichenfolgenumschlossener Wert nicht aus JSON decodiert werden kann. * `CannotEncodeModel(EncodingError)` * EncodingError: Codierungsfehler erkannt. Wird ausgelöst, wenn ein codierbares Modell nicht in JSON codiert werden kann. * `CannotParseResponse` Wird ausgelöst, wenn eine Antwort von der Instanz nicht im erwarteten Format analysiert werden kann. * `Ungültige URL` Wird ausgelöst, wenn eine URL nicht erstellt werden kann. Beispiel: Wenn die Zeichenfolge Zeichen enthält, die in einer URL unzulässig sind oder eine leere Zeichenfolge ist. * `FehlingAnhangMetadata` Wird ausgelöst, wenn der Header der Metadaten des Anhangs fehlt. * `MissingServiceConfiguration` Wird ausgelöst, wenn eine erwartete Servicekonfiguration fehlt. * `FehlingSysID` Wird ausgelöst, wenn ein erwarteter sys_ID-Parameter fehlt. * `Netzwerk (NetzwerkServicefehler)` * GenericError (Zeichenfolge) * Betrieb abgebrochen * Servicedeaktiviert * Serverfehler (Fehler) * Systemfehler (Fehler) Wird ausgelöst, wenn bei einem Netzwerkservice ein Fehler aufgetreten ist. {#NAPIiOS-data-async_O_A_A_S_O__NowDataErroriOS-ul-enum} |
[Tabelle : 5. Rückgaben]

{#NAPIiOS-data-async_O_A_A_S_O__table_kck_kyp_5pb}  
Die folgenden Codebeispiele zeigen, wie diese Methode aufgerufen wird.

    do {
        let dataResponse = try await apiService.data(for: endpoint, queryItems: queryItems, httpHeaders: httpHeaders, body: body)
        // Data request successful
    } catch {
        // Data request failed, NowDataError thrown
    }

## NowAPIService -- Daten(für Endpunkt: NowAPIEndpoint, queryItems: \[Zeichenfolge: Zeichenfolge\]? = Nil, httpHeader: \[Zeichenfolge: Zeichenfolge\]? = Null, Textkörper: Daten? = Null) {#ariaid-title4}

Fordert Daten von der angegebenen an ServiceNowREST-API.
Hinweis:  
Diese Methode ist veraltet. Sie sollten stattdessen die asynchrone/wartet-Implementierung der Methode verwenden.
{#NAPIiOS-data_O_A_A_S__table_sfb_5tp_5pb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Für Endpunkt | [Now APIEndpunkt](https://servicenow-prod.fluidtopics.net/2GC0ZE44BIVAXLC_mGd~yQ#NowAPIEndpointiOSProtocol "Die Now APIEndpunkt das protokoll bietet eine Schnittstelle für den Zugriff auf öffentlich zugängliche ServiceNowREST-APIs.") | Objekt mit ServiceNowREST-API-Endpunkt, auf den zugegriffen werden soll, einschließlich der HTTP-Methode, des relativen Pfads zum Endpunkt, der Pfadparameter und der Angabe, ob eine Authentifizierung erforderlich ist. |
| QueryItems | Array | Optional. Abfrageparameter für den Endpunkt als Schlüssel-Wert-Paare. Standard: Null |
| HTTP-Header | Array | Optional. Anforderungs-HTTP-Header, die vom Endpunkt als Schlüssel-Wert-Paare erforderlich sind. Standard: Null |
| body | Daten | Optional. Anforderungstext-Parameter. Standard: Null |
[Tabelle : 6. Parameter]

{#NAPIiOS-data_O_A_A_S__table_sfb_5tp_5pb} {#NAPIiOS-data_O_A_A_S__table_tfb_5tp_5pb__entry__2}

| Typ | Beschreibung |
|-|-|
| AnyPublisher\<DataResponse, NowDataError\> | Erfolg: Daten, die von der REST-API zurückgegeben werden. Fehler: Now DataError * `AccessToken (AccessTokenProviderError)` * AccessTokenProviderError: Fehlercode oder Meldung des Zugriffstoken-Providers. * AccessTokenRetrievalFehlgeschlagen * UserSessionError(_ Fehler: Fehler) Wird ausgelöst, wenn im Zugriffstoken ein Fehler auftritt. * `Anhangvalidierung` Wird ausgelöst, wenn die Validierung eines Anhangs fehlschlägt. * `BadResponse (statusCode: HTTPStatusCode)` * HTTPStatusCode: Statuscode, der von der Instanz empfangen wurde. Wird ausgelöst, wenn eine Anforderung eine unerwartete Antwort zurückgibt * `CannotDecodeModel (DecodingError)` * DecodingError: Decodierungsfehler erkannt. Wird ausgelöst, wenn ein codierbares Modell nicht aus JSON decodiert werden kann. * `CannotDecodeProperty(Typ: Beliebig, von: Zeichenfolge)` * type: Umschlossener Typ, der aus einer Zeichenfolge decodiert werden soll. * from: Zeichenfolge, die für den angegebenen Typ decodiert werden soll. Wird ausgelöst, wenn ein Zeichenfolgenumschlossener Wert nicht aus JSON decodiert werden kann. * `CannotEncodeModel(EncodingError)` * EncodingError: Codierungsfehler erkannt. Wird ausgelöst, wenn ein codierbares Modell nicht in JSON codiert werden kann. * `CannotParseResponse` Wird ausgelöst, wenn eine Antwort von der Instanz nicht im erwarteten Format analysiert werden kann. * `Ungültige URL` Wird ausgelöst, wenn eine URL nicht erstellt werden kann. Beispiel: Wenn die Zeichenfolge Zeichen enthält, die in einer URL unzulässig sind oder eine leere Zeichenfolge ist. * `FehlingAnhangMetadata` Wird ausgelöst, wenn der Header der Metadaten des Anhangs fehlt. * `MissingServiceConfiguration` Wird ausgelöst, wenn eine erwartete Servicekonfiguration fehlt. * `FehlingSysID` Wird ausgelöst, wenn ein erwarteter sys_ID-Parameter fehlt. * `Netzwerk (NetzwerkServicefehler)` * GenericError (Zeichenfolge) * Betrieb abgebrochen * Servicedeaktiviert * Serverfehler (Fehler) * Systemfehler (Fehler) Wird ausgelöst, wenn bei einem Netzwerkservice ein Fehler aufgetreten ist. {#NAPIiOS-data_O_A_A_S__NowDataErroriOS-ul-enum} |
[Tabelle : 7. Rückgaben]

{#NAPIiOS-data_O_A_A_S__table_tfb_5tp_5pb}  
Das folgende Codebeispiel zeigt, wie diese Funktion aufgerufen wird.

    struct Endpoint: NowAPIEndpoint {
        let httpMethod: HTTPMethod
        let relativePath: String
        let requiresAuthentication: Bool
    }

    /// HTTP request method
    public enum HTTPMethod: CaseIterable {
        case options, get, head, post, put, patch, delete, trace, connect
    }
    let relativePath = "/api/now/account"
    let endPoint = Endpoint(httpMethod: HTTPMethod.get, relativePath: relativePath, requiresAuthentication: true)

    // Using Combine
    apiService.data(for: Endpoint(httpMethod: httpMethod, relativePath: endpointPath, requiresAuthentication: requiresAuthentication), queryItems: queryItems, httpHeaders: httpHeaders, body: body.data(using: .utf8))
      .receive(on: DispatchQueue.main)
      .sink { [weak self] (comp) in
        if case let .failure(error) = comp {
          // Data request failed, return NowDataError
        }
      } receiveValue: { [weak self] (response) in
        // Data request successful
        self?.publish(data: response.data)
      }
      .store(in: &self.subscriptions)
    }


