--- sourceDocument: オーストラリア API リファレンス sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/ja-JP/api-reference Release : - australia ft:locale : - ja-JP ft:publication_title : - オーストラリア API リファレンス ft:clusterId : - crapiref bundleId : - crapiref workflow : - Creator --- # NowAPIService クラス : iOS # NowAPIService クラス : iOS {#ariaid-title1} * リリースバージョン: Australia * * 更新日 2026年03月12日 * * ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 所要時間：13分 NowAPIService クラスは、指定された ServiceNow REST API への要求を実行できるようにする関数を提供します。 {#NowAPIServiceiOSAPI__table_vx2_klw_5pb__entry__3} | 名前 | タイプ | 説明 | |-|-|-| | 構成 | [NowServiceConfiguration](https://servicenow-prod.fluidtopics.net/uTGNTZYlh7StSnwaCDzTxQ#NowServiceConfigurationiOSStruct "NowServiceConfiguration 構造体は、フィーチャ サービスの構成情報を定義します。") | プロトコルに関連付けるサービス構成。 | [表 : 1. プロパティ] {#NowAPIServiceiOSAPI__table_vx2_klw_5pb} ## NowAPIService - data(エンドポイントの場合:NowAPIEndpoint、queryItems:\[文字列:文字列\]、httpHeaders:\[文字列:文字列\]、body:データ、補完:@escaping (Result\) {#ariaid-title2} 指定された ServiceNow REST API からデータを要求し、完了ハンドラーを実行します。 {#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} | 名前 | タイプ | 説明 | |-|-|-| | エンドポイント用 | [NowAPI ノードポイント](https://servicenow-prod.fluidtopics.net/JD88VMYJ3EMT22h8efSKxg#NowAPIEndpointiOSProtocol "NowAPIEndpoint プロトコルは、公開されている ServiceNow REST API にアクセスするためのインターフェイスを提供します。") | HTTP メソッド、エンドポイントへの相対パス、パスパラメーター、認証が必要かどうかなど、アクセスする ServiceNow REST API エンドポイントを含むオブジェクト。 | | queryItem | アレイ | オプション。キー/値ペアとしてのエンドポイントのクエリパラメーター。 デフォルト:nil | | httpヘッダー | アレイ | オプション。エンドポイントがキー/値ペアとして必要とする HTTP ヘッダーを要求します。 デフォルト:nil | | 本文 | 文字列 | オプション。要求本文のパラメーター。 デフォルト:nil | | 完了 | @escaping (Result\) | REST API コールの完了後に実行する補完ハンドラー。 補完ハンドラーの戻り値: * 成功:REST API コールから返されたデータを含む DataResponse。 * 失敗:NowDataError * `アクセストークン (AccessTokenProviderError)` * AccessTokenProviderError:アクセストークンプロバイダーのエラーコードまたはメッセージ。 * アクセストークンの取得に失敗しました * userSessionError(_ error: Error) アクセストークンにエラーがある場合にスローされます。 * `attachmentValidation` 添付ファイルの検証に失敗したときにスローされます。 * `badResponse(statusCode:HTTPStatusCode)` * HTTPStatusCode:インスタンスから受信したステータスコード。 要求から予期しない応答が返されたときにスローされる * `cannotDecodeModel(DecodingError)` * DecodingError:デコードエラーが検出されました。 コード可能モデルを JSON からデコードできない場合にスローされます。 * `cannotDecodeProperty(type: Any, from: String)` * type:文字列からデコードするラップされた型。 * from:指定されたタイプにデコードする文字列。 文字列でラップされた値を JSON からデコードできない場合にスローされます。 * `cannotEncodeModel(EncodingError)` * EncodingError:エンコードエラーが検出されました。 コード可能モデルを JSON にエンコードできない場合にスローされます。 * `cannotParseResponse` インスタンスからの応答を想定される形式に解析できない場合にスローされます。 * `無効なURL` URL を形成できない場合にスローされます。たとえば、文字列に URL で無効な文字が含まれている場合や空の文字列である場合などです。 * `missingAttachmentMetadata` 添付ファイルのメタデータヘッダーがない場合にスローされます。 * `missingServiceConfiguration` 予期されたサービス構成がない場合にスローされます。 * `欠落している SysID` 予期されたsys_idパラメーターが欠落している場合にスローされます。 * `ネットワーク (NetworkServiceError)` * genericError(文字列) * operationCanceled * サービス無効 * serverError (エラー) * systemError (エラー) ネットワークサービスでエラーが発生したときにスローされます。 {#NAPIiOS-data_O_A_A_S_O__NowDataErroriOS-ul-enum} {#NAPIiOS-data_O_A_A_S_O__ul_uzx_thj_ppb} | [表 : 2. パラメーター] {#NAPIiOS-data_O_A_A_S_O__table_jck_kyp_5pb} {#NAPIiOS-data_O_A_A_S_O__table_kck_kyp_5pb__entry__2} | タイプ | 説明 | |-|-| | なし | | [表 : 3. 返される内容] {#NAPIiOS-data_O_A_A_S_O__table_kck_kyp_5pb} 次のコード例は、この関数を呼び出す方法を示しています。 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 - data(エンドポイントの場合:NowAPIEndpoint、queryItems:\[文字列:文字列\]、httpHeaders:\[文字列:文字列\]、本文:データ) 非同期スロー {#ariaid-title3} 指定された ServiceNow REST API からデータを要求します。 {#NAPIiOS-data-async_O_A_A_S_O__table_jck_kyp_5pb__entry__3} | 名前 | タイプ | 説明 | |-|-|-| | エンドポイント用 | [NowAPI ノードポイント](https://servicenow-prod.fluidtopics.net/JD88VMYJ3EMT22h8efSKxg#NowAPIEndpointiOSProtocol "NowAPIEndpoint プロトコルは、公開されている ServiceNow REST API にアクセスするためのインターフェイスを提供します。") | HTTP メソッド、エンドポイントへの相対パス、パスパラメーター、認証が必要かどうかなど、 ServiceNow REST API エンドポイントアクセス権を含むオブジェクト。 | | queryItem | アレイ | オプション。キーと値のペアとしてのエンドポイントのクエリパラメーター 。 デフォルト:nil | | httpヘッダー | アレイ | オプション。エンドポイントが必要とする HTTP ヘッダーを キー/値のペアとして要求します。 デフォルト:nil | | 本文 | 文字列 | オプション。body parameters を要求します。 デフォルト:nil | [表 : 4. パラメーター] {#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} | タイプ | 説明 | |-|-| | データ応答 | メソッドが成功した場合に返されます。REST API コールからのデータ。 | | Now データエラー | メソッドが失敗したときにスローされます。 * `アクセストークン (AccessTokenProviderError)` * AccessTokenProviderError:アクセストークンプロバイダーのエラーコードまたはメッセージ。 * アクセストークンの取得に失敗しました * userSessionError(_ error: Error) アクセストークンにエラーがある場合にスローされます。 * `attachmentValidation` 添付ファイルの検証に失敗したときにスローされます。 * `badResponse(statusCode:HTTPStatusCode)` * HTTPStatusCode:インスタンスから受信したステータスコード。 要求から予期しない応答が返されたときにスローされる * `cannotDecodeModel(DecodingError)` * DecodingError:デコードエラーが検出されました。 コード可能モデルを JSON からデコードできない場合にスローされます。 * `cannotDecodeProperty(type: Any, from: String)` * type:文字列からデコードするラップされた型。 * from:指定されたタイプにデコードする文字列。 文字列でラップされた値を JSON からデコードできない場合にスローされます。 * `cannotEncodeModel(EncodingError)` * EncodingError:エンコードエラーが検出されました。 コード可能モデルを JSON にエンコードできない場合にスローされます。 * `cannotParseResponse` インスタンスからの応答を想定される形式に解析できない場合にスローされます。 * `無効なURL` URL を形成できない場合にスローされます。たとえば、文字列に URL で無効な文字が含まれている場合や空の文字列である場合などです。 * `missingAttachmentMetadata` 添付ファイルのメタデータヘッダーがない場合にスローされます。 * `missingServiceConfiguration` 予期されたサービス構成がない場合にスローされます。 * `欠落している SysID` 予期されたsys_idパラメーターが欠落している場合にスローされます。 * `ネットワーク (NetworkServiceError)` * genericError(文字列) * operationCanceled * サービス無効 * serverError (エラー) * systemError (エラー) ネットワークサービスでエラーが発生したときにスローされます。 {#NAPIiOS-data-async_O_A_A_S_O__NowDataErroriOS-ul-enum} | [表 : 5. 返される内容] {#NAPIiOS-data-async_O_A_A_S_O__table_kck_kyp_5pb} 次のコード例は、このメソッドを呼び出す方法を示しています。 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 - data(エンドポイントの場合: NowAPIEndpoint, queryItems: \[文字列: 文字列\]? = nil, httpHeaders: \[文字列: 文字列\]? = nil, body: Data? = nil) {#ariaid-title4} 指定された ServiceNow REST API からデータを要求します。 注: このメソッドは廃止されました。代わりに、メソッドの async/await 実装を使用する必要があります。 {#NAPIiOS-data_O_A_A_S__table_sfb_5tp_5pb__entry__3} | 名前 | タイプ | 説明 | |-|-|-| | エンドポイント用 | [NowAPI ノードポイント](https://servicenow-prod.fluidtopics.net/JD88VMYJ3EMT22h8efSKxg#NowAPIEndpointiOSProtocol "NowAPIEndpoint プロトコルは、公開されている ServiceNow REST API にアクセスするためのインターフェイスを提供します。") | HTTP メソッド、エンドポイントへの相対パス、パスパラメーター、認証が必要かどうかなど、アクセスする ServiceNow REST API エンドポイントを含むオブジェクト。 | | queryItem | アレイ | オプション。キー/値ペアとしてのエンドポイントのクエリパラメーター。 デフォルト:nil | | httpヘッダー | アレイ | オプション。エンドポイントがキー/値ペアとして必要とする HTTP ヘッダーを要求します。 デフォルト:nil | | 本文 | データ | オプション。要求本文のパラメーター。 デフォルト:nil | [表 : 6. パラメーター] {#NAPIiOS-data_O_A_A_S__table_sfb_5tp_5pb} {#NAPIiOS-data_O_A_A_S__table_tfb_5tp_5pb__entry__2} | タイプ | 説明 | |-|-| | AnyPublisher\ | 成功:REST API によって返されたデータ。 失敗:NowDataError * `アクセストークン (AccessTokenProviderError)` * AccessTokenProviderError:アクセストークンプロバイダーのエラーコードまたはメッセージ。 * アクセストークンの取得に失敗しました * userSessionError(_ error: Error) アクセストークンにエラーがある場合にスローされます。 * `attachmentValidation` 添付ファイルの検証に失敗したときにスローされます。 * `badResponse(statusCode:HTTPStatusCode)` * HTTPStatusCode:インスタンスから受信したステータスコード。 要求から予期しない応答が返されたときにスローされる * `cannotDecodeModel(DecodingError)` * DecodingError:デコードエラーが検出されました。 コード可能モデルを JSON からデコードできない場合にスローされます。 * `cannotDecodeProperty(type: Any, from: String)` * type:文字列からデコードするラップされた型。 * from:指定されたタイプにデコードする文字列。 文字列でラップされた値を JSON からデコードできない場合にスローされます。 * `cannotEncodeModel(EncodingError)` * EncodingError:エンコードエラーが検出されました。 コード可能モデルを JSON にエンコードできない場合にスローされます。 * `cannotParseResponse` インスタンスからの応答を想定される形式に解析できない場合にスローされます。 * `無効なURL` URL を形成できない場合にスローされます。たとえば、文字列に URL で無効な文字が含まれている場合や空の文字列である場合などです。 * `missingAttachmentMetadata` 添付ファイルのメタデータヘッダーがない場合にスローされます。 * `missingServiceConfiguration` 予期されたサービス構成がない場合にスローされます。 * `欠落している SysID` 予期されたsys_idパラメーターが欠落している場合にスローされます。 * `ネットワーク (NetworkServiceError)` * genericError(文字列) * operationCanceled * サービス無効 * serverError (エラー) * systemError (エラー) ネットワークサービスでエラーが発生したときにスローされます。 {#NAPIiOS-data_O_A_A_S__NowDataErroriOS-ul-enum} | [表 : 7. 返される内容] {#NAPIiOS-data_O_A_A_S__table_tfb_5tp_5pb} 次のコード例は、この関数を呼び出す方法を示しています。 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) }