NowTableService クラス - iOS

NowTableService クラスは、既存のServiceNowテーブルのレコードに対して作成、読み取り、更新、および削除操作を実行できる関数を提供します。

表 : 1. プロパティ

名前	タイプ	説明
構成	NowServiceConfiguration	サービスの初期化時に指定された構成設定。

NowTableService - create<Model: SysIdentifiableModel>(_ model: Model, in tableName: String, coder: Coder, writeOptions: FieldWriteOptions, configuration: FetchConfiguration) async throws

指定されたコード化可能モデルを指定されたテーブルに挿入します。

モデル別に新しいレコードを作成するには、モデルが SysIdentifiableModel プロトコルに準拠している必要があります。通常、各テーブルには独自のモデルがあります。

sysIdはServiceNowプラットフォームによって生成されるため、モデルのsys_Idパラメーターは作成時に無視されます。ServiceNowプラットフォームで生成されたsys_Idは、completionハンドラーの結果モデルで返されます。

表 : 2. パラメーター

名前	タイプ	説明
モデル	SysIdentifiableModel	テーブルに挿入するフィールドのモデル定義。
tableName で	文字列	インシデントなどのレコードを書き込むテーブルの名前。
コーダー	コーダー	オプション。ServiceNowインスタンスとの間で送受信されるデータのエンコードまたはデコードに使用するコーダー。 可能な値： default: 既定のエンコーダーは、デバイスの Locale と TimeZone を使用して、yyy-MM-dd HH:mm:ss 形式を使用して日付を書式設定します。 custom(JSONEncoder, JSONDecoder): カスタムコーダーを使用して、JSON のデコード/エンコードをよりきめ細かく制御します。 この列挙体は、特別な日付形式、タイムゾーン、ロケールを使用する場合などに、独自の JSONEncoder と JSONDecoderを提供する場合にのみ使用してください。 let myEncoder = JSONEncoder() myEncoder.dateFormat = … let myDecoder = JSONDecoder() myDecoder.dateFormat = … let coder: Coder = .custom(myEncoder, myDecoder) デフォルト:.default
writeOptions	FieldWriteOptions	オプション。レコードに書き込まれるデータに適用する構成オプション。 デフォルト:nil
構成	FetchConfiguration	オプション。返されるレコード、ページネーションページサイズ制限、取得するフィールド、フィールドに含める内容を定義するフィルターを含む、取得したレコードに適用する構成。 デフォルト:nil - すべてのレコードが返されます。

表 : 3. 戻り値

タイプ	説明
モデル	メソッドが成功したときに返されます。指定されたテーブルに挿入されたコード可能なモデル (sys_Idを含む)。このsys_idを使用して、今後のメソッド呼び出しでこのレコードを参照します。
NowDataError	メソッドが失敗したときにスローされます。 accessToken(AccessTokenProviderError) AccessTokenProviderError:アクセストークンプロバイダーのエラーコードまたはメッセージ。 アクセストークン回収失敗 userSessionError(_ error: Error) アクセストークンにエラーがある場合にスローされます。 attachmentValidation 添付ファイルが検証に失敗した場合にスローされます。 badResponse (statusCode: HTTPStatusCode) HTTPStatusCode:インスタンスから受信したステータスコード。 要求が予期しない応答を返すとスローされます cannotDecodeModel(デコードエラー) DecodingError:デコードエラーが検出されました。 コード可能なモデルを JSON からデコードできない場合にスローされます。 cannotDecodeProperty(type: Any, from: String) type:文字列からデコードするためのラップされた型。 from:指定したタイプにデコードする文字列。 文字列でラップされた値を JSON からデコードできない場合にスローされます。 cannotEncodeModel(EncodingError) EncodingError:エンコードエラーが検出されました。 コード可能なモデルを JSON にエンコードできない場合にスローされます。 応答を解析できません インスタンスからの応答を想定される形式に解析できない場合にスローされます。 無効なURL URL を形成できない場合にスローされます。たとえば、文字列に URL で無効な文字が含まれている場合や、空の文字列である場合などです。 missingAttachmentMetadata 添付ファイルのメタデータヘッダーがない場合にスローされます。 missingServiceConfiguration 想定されるサービス構成がない場合にスローされます。 missingSysID 想定されるsys_idパラメーターがない場合にスローされます。 ネットワーク (NetworkServiceError) genericError(文字列) operationCanceled サービス無効 serverError(エラー) systemError(エラー) ネットワークサービスでエラーが発生するとスローされます。

次のコード例は、このメソッドを呼び出す方法を示しています。

struct User: SysIdentifiableModel {
    var sysId: String = ""
    var name: String
}

let service: NowTableService = ...
let user = User(name: "Ash Williams")
do {
    let result = try await service.create(user, in: “sys_user”)
} catch {
    ...
}

NowTableService - create<Model: SysIdentifiableModel>(_ model: Model, in tableName: String, coder: Coder, writeOptions: FieldWriteOptions, configuration: FetchConfiguration, completion: @escaping (Result<Model, NowDataError>))

指定されたコード化可能モデルを指定されたテーブルに挿入し、 completion ハンドラーを実行します。

モデル別に新しいレコードを作成するには、モデルが SysIdentifiableModel プロトコルに準拠している必要があります。通常、各テーブルには独自のモデルがあります。例：

struct User: SysIdentifiableModel {
  var sysId: String = ""
  var name: String
}

let service: NowTableService = ...
let user = User(name: "Ash Williams")
service.create(Incident(fields: fields), in: tableName, writeOptions: writeOptions, configuration: fetchConfiguration) { [weak self] result in
  switch result {
  case .success(let newUser):
    /// 'newUser' contains the platform assigned 'sys_id', use in subsequent 'update' or 'delete' calls.
  case .failure(let error):
      ...
  }
}

sysIdはServiceNowプラットフォームによって生成されるため、モデルのsys_Idパラメーターは作成時に無視されます。ServiceNowプラットフォームで生成されたsys_Idは、completionハンドラーの結果モデルで返されます。

表 : 4. パラメーター

名前	タイプ	説明
モデル	SysIdentifiableModel	テーブルに挿入するフィールドのモデル定義。
tableName で	文字列	インシデントなどのレコードを書き込むテーブルの名前。
コーダー	コーダー	オプション。ServiceNowインスタンスとの間で送受信されるデータのエンコードまたはデコードに使用するコーダー。 可能な値： default: 既定のエンコーダーは、デバイスの Locale と TimeZone を使用して、yyy-MM-dd HH:mm:ss 形式を使用して日付を書式設定します。 custom(JSONEncoder, JSONDecoder): カスタムコーダーを使用して、JSON のデコード/エンコードをよりきめ細かく制御します。 この列挙体は、特別な日付形式、タイムゾーン、ロケールを使用する場合などに、独自の JSONEncoder と JSONDecoderを提供する場合にのみ使用してください。 let myEncoder = JSONEncoder() myEncoder.dateFormat = … let myDecoder = JSONDecoder() myDecoder.dateFormat = … let coder: Coder = .custom(myEncoder, myDecoder) デフォルト:.default
writeOptions	FieldWriteOptions	オプション。レコードに書き込まれるデータに適用する構成オプション。 デフォルト:nil
構成	FetchConfiguration	オプション。返されるレコード、ページネーションページサイズ制限、取得するフィールド、フィールドに含める内容を定義するフィルターを含む、取得したレコードに適用する構成。 デフォルト:nil - すべてのレコードが返されます。
完了	@escaping (result<model, NowDataError>)	指定されたデコード可能モデルを作成した後に実行する補完ハンドラー。 補完ハンドラーの戻り値: 成功:モデル:作成されたモデルタイプのデータ。 エラー:NowDataError accessToken(AccessTokenProviderError) AccessTokenProviderError:アクセストークンプロバイダーのエラーコードまたはメッセージ。 アクセストークン回収失敗 userSessionError(_ error: Error) アクセストークンにエラーがある場合にスローされます。 attachmentValidation 添付ファイルが検証に失敗した場合にスローされます。 badResponse (statusCode: HTTPStatusCode) HTTPStatusCode:インスタンスから受信したステータスコード。 要求が予期しない応答を返すとスローされます cannotDecodeModel(デコードエラー) DecodingError:デコードエラーが検出されました。 コード可能なモデルを JSON からデコードできない場合にスローされます。 cannotDecodeProperty(type: Any, from: String) type:文字列からデコードするためのラップされた型。 from:指定したタイプにデコードする文字列。 文字列でラップされた値を JSON からデコードできない場合にスローされます。 cannotEncodeModel(EncodingError) EncodingError:エンコードエラーが検出されました。 コード可能なモデルを JSON にエンコードできない場合にスローされます。 応答を解析できません インスタンスからの応答を想定される形式に解析できない場合にスローされます。 無効なURL URL を形成できない場合にスローされます。たとえば、文字列に URL で無効な文字が含まれている場合や、空の文字列である場合などです。 missingAttachmentMetadata 添付ファイルのメタデータヘッダーがない場合にスローされます。 missingServiceConfiguration 想定されるサービス構成がない場合にスローされます。 missingSysID 想定されるsys_idパラメーターがない場合にスローされます。 ネットワーク (NetworkServiceError) genericError(文字列) operationCanceled サービス無効 serverError(エラー) systemError(エラー) ネットワークサービスでエラーが発生するとスローされます。

表 : 5. 戻り値

タイプ	説明
なし

struct User: SysIdentifiableModel {
  var sysId: String = ""
  var name: String
}

let service: NowTableService = ...
let user = User(name: "Ash Williams")
service.create(Incident(fields: fields), in: tableName, writeOptions: writeOptions, configuration: fetchConfiguration) { [weak self] result in
  switch result {
  case .success(let newUser):
    /// 'newUser' contains the platform assigned 'sys_id' to use in subsequent update or delete calls.
  case .failure(let error):
   ...
  }
}

NowTableService - create<Model: SysIdentifiableModel>(model: Model, in tableName: String, path: String = Constants.resultPath, coder: Coder = .default, writeOptions: FieldWriteOptions? = nil, configuration: FetchConfiguration = nil)

指定されたテーブルに 1 つのコード化可能なモデルを挿入します。

注:

このメソッドは廃止されました。代わりに、メソッドの async/await 実装を使用する必要があります。

モデル別に新しいレコードを作成するには、モデルが SysIdentifiableModel プロトコルに準拠している必要があります。通常、各テーブルには独自のモデルがあります。例：

struct User: SysIdentifiableModel {
  var sysId: String = ""
  var name: String
}

let service: NowTableService = ...
let user = User(name: "Ash Williams")
service.create(Incident(fields: fields), in: tableName, writeOptions: writeOptions, configuration: fetchConfiguration) { [weak self] result in
  switch result {
  case .success(let newUser):
    /// 'newUser' contains the platform assigned 'sys_id', use in subsequent 'update' or 'delete' calls.
  case .failure(let error):
      ...
  }
}

注:

モデルの sys_Id パラメーターは作成時に無視されます。sysIdはServiceNowプラットフォームによってアサインされます。ServiceNowプラットフォームで生成されたsys_Idは、パブリッシャーの receiveValue コールバックモデルで返されます。

表 : 6. パラメーター

名前	タイプ	説明
モデル	SysIdentifiableModel	テーブルに挿入する SysIdentifiableModel モデル。
tableName で	文字列	インシデントなどのレコードを書き込むテーブルの名前。
パス	文字列	オプション。ネストされたタイプのドット区切りパス。たとえば、より詳細なネストを行う には、result や foo.bar.baz などです。 デフォルト: Constants.resultPath
コーダー	コーダー	オプション。ServiceNowインスタンスとの間で送受信されるデータのエンコードまたはデコードに使用するコーダー。 可能な値： default: 既定のエンコーダーは、デバイスの Locale と TimeZone を使用して、yyy-MM-dd HH:mm:ss 形式を使用して日付を書式設定します。 custom(JSONEncoder, JSONDecoder): カスタムコーダーを使用して、JSON のデコード/エンコードをよりきめ細かく制御します。 この列挙体は、特別な日付形式、タイムゾーン、ロケールを使用する場合などに、独自の JSONEncoder と JSONDecoderを提供する場合にのみ使用してください。 let myEncoder = JSONEncoder() myEncoder.dateFormat = … let myDecoder = JSONDecoder() myDecoder.dateFormat = … let coder: Coder = .custom(myEncoder, myDecoder) デフォルト:.default
writeOptions	FieldWriteOptions	オプション。レコードに書き込まれるデータに適用する構成オプション。 デフォルト:nil
構成	FetchConfiguration	オプション。返されるレコード、ページネーションページサイズ制限、取得するフィールド、フィールドに含める内容を定義するフィルターを含む、取得したレコードに適用する構成。 デフォルト:nil - すべてのレコードが返されます。

表 : 7. 戻り値

タイプ	説明
AnyPublisher<Model,NowDataError>	成功: sys_Idを含む、指定されたテーブルに挿入されたコード化可能なモデル。このsys_idを使用して、今後のメソッド呼び出しでこのレコードを参照します。 エラー:NowDataError @escaping (result<model, NowDataError>)

単一のレコードをユーザー [sys_user] テーブルに挿入する方法を示しています。

struct User: SysIdentifiableModel {
  var sysId: String = ""
  var name: String
}

let service: NowTableService = ...
let user = User(name: "Ash Williams")
let publisher: AnyPublisher<User, NowDataError> = service.create(user, in: "sys_user")
publisher
  .subscribe(on: DispatchQueue.global())
  .receive(on: DispatchQueue.main)
  .sink { [weak self] completion in
    ...
  } receiveValue: { [weak self] newUser in
      /// 'newUser' contains the ServiceNow platform assigned 'sys_id' to use in subsequent update and delete calls.
     ...
  }
  .store(in: &subscriptions)

NowTableService - createRecord(with fields: [FieldName: FieldValue], in tableName: String, writeOptions: FieldWriteOptions? = nil, configuration: FieldReadConfiguration? = nil) async throws

指定されたフィールドを含む指定されたテーブルにレコードを挿入します。

Publisher は、カスタムの Codable モデルにデコードできるデータを出力するか、 NowTableService - paginator<Model: Decodable>(from tableName: String, path: String = Constants.resultPath, coder: Coder = .default, configuration: FetchConfiguration? = nil) 関数を使用することもできます。 または、便利な関数 convertToRecords() を使用して、データを NowRecord オブジェクトに変換することもできます。次に、パブリッシャーを変換して NowRecord を発行する方法を示します。。

let dataPublisher: AnyPublisher<Data, NowDataError> = ...
let recordsPublisher: AnyPublisher<[NowRecord], NowDataError> = myPublisher.convertToRecords()

注:

レコード内のすべてのフィールドは更新できない場合があります。たとえば、プリフィックスが sys_ のフィールドは、通常、自動的に生成されるシステムパラメーターであり、更新することはできません。指定されず、システムによって自動生成されないフィールドは、関連するデータタイプの null 値に設定されます。

表 : 8. パラメーター

名前	タイプ	説明
フィールドあり	[FieldName: FieldValue]	レコードに含めるフィールドの名前と値のペア。
tableName で	文字列	インシデントなどのレコードを書き込むテーブルの名前。
writeOptions	FieldWriteOptions	オプション。レコードに書き込まれるデータに適用する構成オプション。 デフォルト:nil
構成	FetchConfiguration	オプション。返されるレコード、ページネーションページサイズ制限、取得するフィールド、フィールドに含める内容を定義するフィルターを含む、取得したレコードに適用する構成。 デフォルト:nil - すべてのレコードが返されます。

表 : 9. 返される内容

タイプ	説明
データ	メソッドが成功したときに返されます。新規レコードを含むデータオブジェクト。
NowDataError	メソッドが失敗したときにスローされます。 accessToken(AccessTokenProviderError) AccessTokenProviderError:アクセストークンプロバイダーのエラーコードまたはメッセージ。 アクセストークン回収失敗 userSessionError(_ error: Error) アクセストークンにエラーがある場合にスローされます。 attachmentValidation 添付ファイルが検証に失敗した場合にスローされます。 badResponse (statusCode: HTTPStatusCode) HTTPStatusCode:インスタンスから受信したステータスコード。 要求が予期しない応答を返すとスローされます cannotDecodeModel(デコードエラー) DecodingError:デコードエラーが検出されました。 コード可能なモデルを JSON からデコードできない場合にスローされます。 cannotDecodeProperty(type: Any, from: String) type:文字列からデコードするためのラップされた型。 from:指定したタイプにデコードする文字列。 文字列でラップされた値を JSON からデコードできない場合にスローされます。 cannotEncodeModel(EncodingError) EncodingError:エンコードエラーが検出されました。 コード可能なモデルを JSON にエンコードできない場合にスローされます。 応答を解析できません インスタンスからの応答を想定される形式に解析できない場合にスローされます。 無効なURL URL を形成できない場合にスローされます。たとえば、文字列に URL で無効な文字が含まれている場合や、空の文字列である場合などです。 missingAttachmentMetadata 添付ファイルのメタデータヘッダーがない場合にスローされます。 missingServiceConfiguration 想定されるサービス構成がない場合にスローされます。 missingSysID 想定されるsys_idパラメーターがない場合にスローされます。 ネットワーク (NetworkServiceError) genericError(文字列) operationCanceled サービス無効 serverError(エラー) systemError(エラー) ネットワークサービスでエラーが発生するとスローされます。

次のコード例は、このメソッドを呼び出す方法を示しています。

do {
    let dataResult: Data = try await tableService.createRecord(with: fields, in: tableName, writeOptions: writeOptions, configuration: configuration)
    let recordResult: NowRecord = dataResult.convertToRecord()
} catch {
    print("Record creation failed with NowDataError: \(error)")
}

NowTableService - createRecord(with fields: [FieldName: FieldValue], in tableName: String, writeOptions: FieldWriteOptions, configuration: FieldReadConfiguration, completion: @escaping (Result<Data, NowDataError>)

指定されたテーブルに指定されたレコードを挿入し、レコードが保存された後に completion ハンドラーを実行します。

必要に応じて、返された結果をカスタムの Codable モデルにデコードするか、代わりに関数 NowTableService - paginator<Model: Decodable>(from tableName: String, path: String = Constants.resultPath, coder: Coder = .default, configuration: FetchConfiguration? = nil) を使用できます。 または、便利な関数 convertToRecords() を使用して、データを NowRecord オブジェクトに変換することもできます。次に、パブリッシャーを変換して NowRecord を発行する方法を示します。

let dataPublisher: AnyPublisher<Data, NowDataError> = ...
let recordsPublisher: AnyPublisher<[NowRecord], NowDataError> = myResult.convertToRecords()

注:

レコード内のすべてのフィールドは更新できない場合があります。たとえば、プリフィックスが sys_ のフィールドは、通常、自動的に生成されるシステムパラメーターであり、更新することはできません。指定されず、システムによって自動生成されないフィールドは、関連するデータタイプの null 値に設定されます。

表 : 10. パラメーター

名前	タイプ	説明
フィールドあり	[FieldName: FieldValue]	レコードに含めるフィールドの名前と値のペア。
tableName で	文字列	インシデントなどのレコードを書き込むテーブルの名前。
writeOptions	FieldWriteOptions	オプション。レコードに書き込まれるデータに適用する構成オプション。 デフォルト:nil
構成	FieldReadConfiguration	オプション。返すフィールドとフィールドに何を含めるかを指定する構成オプション。 デフォルト:nil
完了	@escaping (result<data, NowDataError>)	レコードが取得された後に実行する補完ハンドラー。 戻り値: 成功:データ:要求されたレコード エラー:NowDataError accessToken(AccessTokenProviderError) AccessTokenProviderError:アクセストークンプロバイダーのエラーコードまたはメッセージ。 アクセストークン回収失敗 userSessionError(_ error: Error) アクセストークンにエラーがある場合にスローされます。 attachmentValidation 添付ファイルが検証に失敗した場合にスローされます。 badResponse (statusCode: HTTPStatusCode) HTTPStatusCode:インスタンスから受信したステータスコード。 要求が予期しない応答を返すとスローされます cannotDecodeModel(デコードエラー) DecodingError:デコードエラーが検出されました。 コード可能なモデルを JSON からデコードできない場合にスローされます。 cannotDecodeProperty(type: Any, from: String) type:文字列からデコードするためのラップされた型。 from:指定したタイプにデコードする文字列。 文字列でラップされた値を JSON からデコードできない場合にスローされます。 cannotEncodeModel(EncodingError) EncodingError:エンコードエラーが検出されました。 コード可能なモデルを JSON にエンコードできない場合にスローされます。 応答を解析できません インスタンスからの応答を想定される形式に解析できない場合にスローされます。 無効なURL URL を形成できない場合にスローされます。たとえば、文字列に URL で無効な文字が含まれている場合や、空の文字列である場合などです。 missingAttachmentMetadata 添付ファイルのメタデータヘッダーがない場合にスローされます。 missingServiceConfiguration 想定されるサービス構成がない場合にスローされます。 missingSysID 想定されるsys_idパラメーターがない場合にスローされます。 ネットワーク (NetworkServiceError) genericError(文字列) operationCanceled サービス無効 serverError(エラー) systemError(エラー) ネットワークサービスでエラーが発生するとスローされます。

表 : 11. 返される内容

タイプ	説明
なし

次のコード例は、この関数を呼び出す方法を示しています。

let fields = ["short_description" : "test description"]
let writeOptions: FieldWriteOptions = [.suppressAutoSysField, .treatInputValuesAsDisplayValues]
let readConfiguration = FieldReadConfiguration(includeFields: ["number", "short_description"])

tableService.createRecord(with: fields, in: tableName, writeOptions: writeOptions, configuration: readConfiguration) { [weak self] result in
  switch result {
    case .success(let dataResult):
      let recordResult: NowRecord = dataResult.convertToRecord()
    case .failure(let error):
       print("Record creation failed with NowDataError: \(error)")
  }
}

NowTableService - createRecord(with fields: [FieldName: FieldValue], in tableName: String, writeOptions: FieldWriteOptions? = nil, configuration: FieldReadConfiguration? = nil)

指定されたフィールドを含む指定されたテーブルにレコードを挿入します。

注:

このメソッドは廃止されました。代わりに、メソッドの async/await 実装を使用する必要があります。

Publisher は、カスタムの Codable モデルにデコードできるデータを出力するか、 NowTableService - paginator<Model: Decodable>(from tableName: String, path: String = Constants.resultPath, coder: Coder = .default, configuration: FetchConfiguration? = nil) 関数を使用することもできます。 または、便利な関数 convertToRecords() を使用して、データを NowRecord オブジェクトに変換することもできます。次に、パブリッシャーを変換して NowRecord を発行する方法を示します。。

let dataPublisher: AnyPublisher<Data, NowDataError> = ...
let recordsPublisher: AnyPublisher<[NowRecord], NowDataError> = myPublisher.convertToRecords()

注:

レコード内のすべてのフィールドは更新できない場合があります。たとえば、プリフィックスが sys_ のフィールドは、通常、自動的に生成されるシステムパラメーターであり、更新することはできません。指定されず、システムによって自動生成されないフィールドは、関連するデータタイプの null 値に設定されます。

表 : 12. パラメーター

名前	タイプ	説明
フィールドあり	[FieldName: FieldValue]	レコードに含めるフィールドの名前と値のペア。
tableName で	文字列	インシデントなどのレコードを書き込むテーブルの名前。
writeOptions	FieldWriteOptions	オプション。レコードに書き込まれるデータに適用する構成オプション。 デフォルト:nil
構成	FetchConfiguration	オプション。返されるレコード、ページネーションページサイズ制限、取得するフィールド、フィールドに含める内容を定義するフィルターを含む、取得したレコードに適用する構成。 デフォルト:nil - すべてのレコードが返されます。

表 : 13. 返される内容

タイプ

説明

AnyPublisher<Data、NowDataError>

成功:更新されたレコードを含むデータオブジェクト。 エラー:NowDataError accessToken(AccessTokenProviderError) AccessTokenProviderError:アクセストークンプロバイダーのエラーコードまたはメッセージ。 アクセストークン回収失敗 userSessionError(_ error: Error) アクセストークンにエラーがある場合にスローされます。 attachmentValidation 添付ファイルが検証に失敗した場合にスローされます。 badResponse (statusCode: HTTPStatusCode) HTTPStatusCode:インスタンスから受信したステータスコード。 要求が予期しない応答を返すとスローされます cannotDecodeModel(デコードエラー) DecodingError:デコードエラーが検出されました。 コード可能なモデルを JSON からデコードできない場合にスローされます。 cannotDecodeProperty(type: Any, from: String) type:文字列からデコードするためのラップされた型。 from:指定したタイプにデコードする文字列。 文字列でラップされた値を JSON からデコードできない場合にスローされます。 cannotEncodeModel(EncodingError) EncodingError:エンコードエラーが検出されました。 コード可能なモデルを JSON にエンコードできない場合にスローされます。 応答を解析できません インスタンスからの応答を想定される形式に解析できない場合にスローされます。 無効なURL URL を形成できない場合にスローされます。たとえば、文字列に URL で無効な文字が含まれている場合や、空の文字列である場合などです。 missingAttachmentMetadata 添付ファイルのメタデータヘッダーがない場合にスローされます。 missingServiceConfiguration 想定されるサービス構成がない場合にスローされます。 missingSysID 想定されるsys_idパラメーターがない場合にスローされます。 ネットワーク (NetworkServiceError) genericError(文字列) operationCanceled サービス無効 serverError(エラー) systemError(エラー) ネットワークサービスでエラーが発生するとスローされます。

この例では、指定したテーブルに指定したフィールドを使用してレコードを挿入する関数を作成する方法を示します。呼び出しの出力は ByteArray で、データを任意のモデルに変換できます。

tableService.createRecord(with: fields, in: tableName, writeOptions: writeOptions, configuration: readConfiguration)
    .subscribe(on: DispatchQueue.global())
    .receive(on: DispatchQueue.main)
    .convertToRecord()
    .sink { completion in
        if case let .failure(error) = completion {
            print("Record creation failed with NowDataError: \(error)")
        }
    } receiveValue: { record in
        print("Created NowRecord: \(record)")
    }
    .store(in: &subscriptions)

NowTableService - delete(_ model: Model, from tableName: String) async throws

指定されたテーブルから指定されたコード化可能モデルを削除します。

表 : 14. パラメーター

名前	タイプ	説明
モデル	モデル	テーブルから削除する SysIdentifiableModel。削除するレコードのsys_idが含まれている必要があります。
tableName から	文字列	インシデントなどの情報を削除するテーブルの名前。

表 : 15. 返される内容

タイプ	説明
なし	メソッドが成功した場合は何も返されません。
NowDataError	メソッドが失敗したときにスローされます。 accessToken(AccessTokenProviderError) AccessTokenProviderError:アクセストークンプロバイダーのエラーコードまたはメッセージ。 アクセストークン回収失敗 userSessionError(_ error: Error) アクセストークンにエラーがある場合にスローされます。 attachmentValidation 添付ファイルが検証に失敗した場合にスローされます。 badResponse (statusCode: HTTPStatusCode) HTTPStatusCode:インスタンスから受信したステータスコード。 要求が予期しない応答を返すとスローされます cannotDecodeModel(デコードエラー) DecodingError:デコードエラーが検出されました。 コード可能なモデルを JSON からデコードできない場合にスローされます。 cannotDecodeProperty(type: Any, from: String) type:文字列からデコードするためのラップされた型。 from:指定したタイプにデコードする文字列。 文字列でラップされた値を JSON からデコードできない場合にスローされます。 cannotEncodeModel(EncodingError) EncodingError:エンコードエラーが検出されました。 コード可能なモデルを JSON にエンコードできない場合にスローされます。 応答を解析できません インスタンスからの応答を想定される形式に解析できない場合にスローされます。 無効なURL URL を形成できない場合にスローされます。たとえば、文字列に URL で無効な文字が含まれている場合や、空の文字列である場合などです。 missingAttachmentMetadata 添付ファイルのメタデータヘッダーがない場合にスローされます。 missingServiceConfiguration 想定されるサービス構成がない場合にスローされます。 missingSysID 想定されるsys_idパラメーターがない場合にスローされます。 ネットワーク (NetworkServiceError) genericError(文字列) operationCanceled サービス無効 serverError(エラー) systemError(エラー) ネットワークサービスでエラーが発生するとスローされます。

次のコード例は、このメソッドを呼び出す方法を示しています。

do { 
    try await tableService.delete(model, from: tableName)
    print("Deletion successful.")
} catch {
    print("Deletion failed with NowDataError: \(error)")
}

NowTableService - delete(_ model: Model, from tableName: String, completion: @escaping (Result<Void, NowDataError>))

指定されたテーブルから指定されたコード可能モデルを削除し、適切な completion ハンドラーを実行します。

表 : 16. パラメーター

名前	タイプ	説明
モデル	モデル	テーブルから削除する SysIdentifiableModel。削除するレコードのsys_idが含まれている必要があります。
tableName から	文字列	インシデントなどの情報を削除するテーブルの名前。
完了	@escaping (Result<Void, NowDataError>)	指定されたコード可能モデルを削除した後に実行する補完ハンドラー。 戻り値: 成功:何も返されませんでした エラー:NowDataError accessToken(AccessTokenProviderError) AccessTokenProviderError:アクセストークンプロバイダーのエラーコードまたはメッセージ。 アクセストークン回収失敗 userSessionError(_ error: Error) アクセストークンにエラーがある場合にスローされます。 attachmentValidation 添付ファイルが検証に失敗した場合にスローされます。 badResponse (statusCode: HTTPStatusCode) HTTPStatusCode:インスタンスから受信したステータスコード。 要求が予期しない応答を返すとスローされます cannotDecodeModel(デコードエラー) DecodingError:デコードエラーが検出されました。 コード可能なモデルを JSON からデコードできない場合にスローされます。 cannotDecodeProperty(type: Any, from: String) type:文字列からデコードするためのラップされた型。 from:指定したタイプにデコードする文字列。 文字列でラップされた値を JSON からデコードできない場合にスローされます。 cannotEncodeModel(EncodingError) EncodingError:エンコードエラーが検出されました。 コード可能なモデルを JSON にエンコードできない場合にスローされます。 応答を解析できません インスタンスからの応答を想定される形式に解析できない場合にスローされます。 無効なURL URL を形成できない場合にスローされます。たとえば、文字列に URL で無効な文字が含まれている場合や、空の文字列である場合などです。 missingAttachmentMetadata 添付ファイルのメタデータヘッダーがない場合にスローされます。 missingServiceConfiguration 想定されるサービス構成がない場合にスローされます。 missingSysID 想定されるsys_idパラメーターがない場合にスローされます。 ネットワーク (NetworkServiceError) genericError(文字列) operationCanceled サービス無効 serverError(エラー) systemError(エラー) ネットワークサービスでエラーが発生するとスローされます。

表 : 17. 戻り値

タイプ	説明
なし

次のコード例は、この関数を呼び出す方法を示しています。

tableService.delete(Incident(sysId: sysId), from: tableName) { [weak self] result in
  switch result {
    case .success:
      // Delete successfully
    case .failure(let error):
      // Failed to delete with NowDataError
  }
}

NowTableService - delete(_ model: Model, from tableName: String)

指定されたテーブルから指定されたコード化可能モデルを削除します。

注:

このメソッドは廃止されました。代わりに、メソッドの async/await 実装を使用する必要があります。

表 : 18. パラメーター

名前	タイプ	説明
モデル	モデル	テーブルから削除する SysIdentifiableModel。削除するレコードのsys_idが含まれている必要があります。
tableName から	文字列	インシデントなどの情報を削除するテーブルの名前。

表 : 19. 返される内容

タイプ

説明

AnyPublisher<Void、NowDataError>

成功:何も返されませんでした エラー:NowDataError accessToken(AccessTokenProviderError) AccessTokenProviderError:アクセストークンプロバイダーのエラーコードまたはメッセージ。 アクセストークン回収失敗 userSessionError(_ error: Error) アクセストークンにエラーがある場合にスローされます。 attachmentValidation 添付ファイルが検証に失敗した場合にスローされます。 badResponse (statusCode: HTTPStatusCode) HTTPStatusCode:インスタンスから受信したステータスコード。 要求が予期しない応答を返すとスローされます cannotDecodeModel(デコードエラー) DecodingError:デコードエラーが検出されました。 コード可能なモデルを JSON からデコードできない場合にスローされます。 cannotDecodeProperty(type: Any, from: String) type:文字列からデコードするためのラップされた型。 from:指定したタイプにデコードする文字列。 文字列でラップされた値を JSON からデコードできない場合にスローされます。 cannotEncodeModel(EncodingError) EncodingError:エンコードエラーが検出されました。 コード可能なモデルを JSON にエンコードできない場合にスローされます。 応答を解析できません インスタンスからの応答を想定される形式に解析できない場合にスローされます。 無効なURL URL を形成できない場合にスローされます。たとえば、文字列に URL で無効な文字が含まれている場合や、空の文字列である場合などです。 missingAttachmentMetadata 添付ファイルのメタデータヘッダーがない場合にスローされます。 missingServiceConfiguration 想定されるサービス構成がない場合にスローされます。 missingSysID 想定されるsys_idパラメーターがない場合にスローされます。 ネットワーク (NetworkServiceError) genericError(文字列) operationCanceled サービス無効 serverError(エラー) systemError(エラー) ネットワークサービスでエラーが発生するとスローされます。

次のコード例は、この関数を呼び出す方法を示しています。

tableService.delete(Incident(sysId: sysId), from: tableName)
  .subscribe(on: DispatchQueue.global())
  .receive(on: DispatchQueue.main)
  .sink { [weak self] completion in
    switch completion {
      case .finished:
        // Delete successfully
      case .failure(let error):
        // Failed to delete with NowDataError
    }
  } receiveValue: { _ in
  }
  .store(in: &subscriptions)

NowTableService - deleteRecord(sysId: SysID, from tableName: String) 非同期がスローします

指定されたテーブルから指定されたレコードを削除します。

表 : 20. パラメーター

名前	タイプ	説明
sysId	文字列	削除するレコードの sys_id。
tableName から	文字列	インシデントなどの情報を削除するテーブルの名前。

表 : 21. 返される内容

タイプ	説明
なし	メソッドが成功した場合は何も返されません。
NowDataError	メソッドが失敗したときにスローされます。 accessToken(AccessTokenProviderError) AccessTokenProviderError:アクセストークンプロバイダーのエラーコードまたはメッセージ。 アクセストークン回収失敗 userSessionError(_ error: Error) アクセストークンにエラーがある場合にスローされます。 attachmentValidation 添付ファイルが検証に失敗した場合にスローされます。 badResponse (statusCode: HTTPStatusCode) HTTPStatusCode:インスタンスから受信したステータスコード。 要求が予期しない応答を返すとスローされます cannotDecodeModel(デコードエラー) DecodingError:デコードエラーが検出されました。 コード可能なモデルを JSON からデコードできない場合にスローされます。 cannotDecodeProperty(type: Any, from: String) type:文字列からデコードするためのラップされた型。 from:指定したタイプにデコードする文字列。 文字列でラップされた値を JSON からデコードできない場合にスローされます。 cannotEncodeModel(EncodingError) EncodingError:エンコードエラーが検出されました。 コード可能なモデルを JSON にエンコードできない場合にスローされます。 応答を解析できません インスタンスからの応答を想定される形式に解析できない場合にスローされます。 無効なURL URL を形成できない場合にスローされます。たとえば、文字列に URL で無効な文字が含まれている場合や、空の文字列である場合などです。 missingAttachmentMetadata 添付ファイルのメタデータヘッダーがない場合にスローされます。 missingServiceConfiguration 想定されるサービス構成がない場合にスローされます。 missingSysID 想定されるsys_idパラメーターがない場合にスローされます。 ネットワーク (NetworkServiceError) genericError(文字列) operationCanceled サービス無効 serverError(エラー) systemError(エラー) ネットワークサービスでエラーが発生するとスローされます。

次のコード例は、このメソッドを呼び出す方法を示しています。

do {
    try await tableService.deleteRecord(sysId: sysId, from: tableName)
    print("Deletion successful.")
} catch {
    print("Deletion failed with NowDataError: \(error)")
}

NowTableService - deleteRecord(sysId: SysID, from tableName: String, completion: @escaping (Result<Void, NowDataError>))

指定されたテーブルから指定されたレコードを削除し、レコードが削除された後に completion オブジェクトを実行します。

表 : 22. パラメーター

名前	タイプ	説明
sysId	文字列	削除するレコードの sys_id。
tableName から	文字列	インシデントなどの情報を削除するテーブルの名前。
完了	@escaping (Result<Void, NowDataError>)	成功:何も返されません。 エラー:NowDataError accessToken(AccessTokenProviderError) AccessTokenProviderError:アクセストークンプロバイダーのエラーコードまたはメッセージ。 アクセストークン回収失敗 userSessionError(_ error: Error) アクセストークンにエラーがある場合にスローされます。 attachmentValidation 添付ファイルが検証に失敗した場合にスローされます。 badResponse (statusCode: HTTPStatusCode) HTTPStatusCode:インスタンスから受信したステータスコード。 要求が予期しない応答を返すとスローされます cannotDecodeModel(デコードエラー) DecodingError:デコードエラーが検出されました。 コード可能なモデルを JSON からデコードできない場合にスローされます。 cannotDecodeProperty(type: Any, from: String) type:文字列からデコードするためのラップされた型。 from:指定したタイプにデコードする文字列。 文字列でラップされた値を JSON からデコードできない場合にスローされます。 cannotEncodeModel(EncodingError) EncodingError:エンコードエラーが検出されました。 コード可能なモデルを JSON にエンコードできない場合にスローされます。 応答を解析できません インスタンスからの応答を想定される形式に解析できない場合にスローされます。 無効なURL URL を形成できない場合にスローされます。たとえば、文字列に URL で無効な文字が含まれている場合や、空の文字列である場合などです。 missingAttachmentMetadata 添付ファイルのメタデータヘッダーがない場合にスローされます。 missingServiceConfiguration 想定されるサービス構成がない場合にスローされます。 missingSysID 想定されるsys_idパラメーターがない場合にスローされます。 ネットワーク (NetworkServiceError) genericError(文字列) operationCanceled サービス無効 serverError(エラー) systemError(エラー) ネットワークサービスでエラーが発生するとスローされます。

表 : 23. 戻り値

タイプ	説明
なし

次のコード例は、この関数を呼び出す方法を示しています。

tableService.deleteRecord(sysId: sysId, from: tableName) { [weak self] result in
  switch result {
    case .success:
      // Delete successfully
    case .failure(let error):
      // Failed to delete with NowDataError
  }
}

NowTableService - deleteRecord(sysId: SysID, from tableName: String)

指定されたテーブルから指定されたレコードを削除します。

注:

このメソッドは廃止されました。代わりに、メソッドの async/await 実装を使用する必要があります。

表 : 24. パラメーター

名前	タイプ	説明
sysId	文字列	削除するレコードの sys_id。
tableName から	文字列	インシデントなどの情報を削除するテーブルの名前。

表 : 25. 返される内容

タイプ

説明

AnyPublisher<Void、NowDataError>

成功:何も返されませんでした エラー:NowDataError accessToken(AccessTokenProviderError) AccessTokenProviderError:アクセストークンプロバイダーのエラーコードまたはメッセージ。 アクセストークン回収失敗 userSessionError(_ error: Error) アクセストークンにエラーがある場合にスローされます。 attachmentValidation 添付ファイルが検証に失敗した場合にスローされます。 badResponse (statusCode: HTTPStatusCode) HTTPStatusCode:インスタンスから受信したステータスコード。 要求が予期しない応答を返すとスローされます cannotDecodeModel(デコードエラー) DecodingError:デコードエラーが検出されました。 コード可能なモデルを JSON からデコードできない場合にスローされます。 cannotDecodeProperty(type: Any, from: String) type:文字列からデコードするためのラップされた型。 from:指定したタイプにデコードする文字列。 文字列でラップされた値を JSON からデコードできない場合にスローされます。 cannotEncodeModel(EncodingError) EncodingError:エンコードエラーが検出されました。 コード可能なモデルを JSON にエンコードできない場合にスローされます。 応答を解析できません インスタンスからの応答を想定される形式に解析できない場合にスローされます。 無効なURL URL を形成できない場合にスローされます。たとえば、文字列に URL で無効な文字が含まれている場合や、空の文字列である場合などです。 missingAttachmentMetadata 添付ファイルのメタデータヘッダーがない場合にスローされます。 missingServiceConfiguration 想定されるサービス構成がない場合にスローされます。 missingSysID 想定されるsys_idパラメーターがない場合にスローされます。 ネットワーク (NetworkServiceError) genericError(文字列) operationCanceled サービス無効 serverError(エラー) systemError(エラー) ネットワークサービスでエラーが発生するとスローされます。

この例では、指定したテーブルのレコードを削除する関数を作成する方法を示します。

tableService.deleteRecord(sysId: sysId, from: tableName) 
    .subscribe(on: DispatchQueue.global())
    .receive(on: DispatchQueue.main)
    .sink { completion in
        switch completion {
        case .finished:
            print("Record deleted.")
        case .failure(let error):
            print("Deletion failed with NowDataError: \(error)")
        }
    } receiveValue: { _ in }
    .store(in: &subscriptions)

NowServiceTable - init(configuration: NowServiceConfiguration, coreServiceProvider: NowCoreServiceProprovideing? = nil)

NowTableService オブジェクトを作成します。

表 : 26. パラメーター

名前	タイプ	説明
構成	NowServiceConfiguration	サービスの作成時に使用する設定パラメーター。
コアサービスプロバイダ	NowCoreServiceProviding	オプション。NowTableService に関連付けるサービスプロバイダー。 デフォルト:nil

次のコード例は、この関数を呼び出す方法を示しています。

guard let coreService = NowSDK.core() else {
  // Error with NowServiceError.sdkNotConfigured
  return
}

guard 
  let instanceUrl = URL(string: "http://sample.service-now.com") , 
  let serviceConfig = NowSDK.makeServiceConfiguration(for: instanceUrl) else {
    // Could not create service – 
    // NowServiceError.serviceConfigurationInvalid
    return
  }
let tableService = NowTableService (configuration: serviceConfig, coreServiceProvider: coreService)

NowTableService - model<Model: Decodable>(sysId: SysID? = nil, from tableName: String, path: String = Constants.resultPath, coder: Coder = .default, configuration: FetchConfiguration? = nil) 非同期スロー

指定されたテーブルからデコード可能なモデルを取得できるようにします。

テーブル API 応答は、次のような result パラメーター内にネストされます。

{
  "result": [
    { "name": "Ash Williams" },
    { "name": "Lionel Cosgrove" },
    { "name": "Laurie Strode" }
  ]
}

結果セットが大きい場合は、ページネーションされたモデルをフェッチするために、 NowTableService - paginator(from tableName: String, configuration: FetchConfiguration? = nil) または NowTableService - paginator<Model: Decodable>(from tableName: String, path: String = Constants.resultPath, coder: Coder = .default, configuration: FetchConfiguration? = nil) のいずれかのページネーション関数を使用します。

表 : 27. パラメーター

名前	タイプ	説明
sysId あり	SysID	オプション。返されるレコードの sys_id。特定のレコードを取得する場合は、sys_idを入力します。 デフォルト:nil
tableName から	文字列	インシデントなどのレコードの取得元のテーブルの名前。
パス	文字列	ネストされたタイプのドット区切りパス。たとえば、より詳細なネストを行う には、result や foo.bar.baz などです。 デフォルト: result
コーダー	コーダー	オプション。ServiceNowインスタンスとの間で送受信されるデータのエンコードまたはデコードに使用するコーダー。 可能な値： default: 既定のエンコーダーは、デバイスの Locale と TimeZone を使用して、yyy-MM-dd HH:mm:ss 形式を使用して日付を書式設定します。 custom(JSONEncoder, JSONDecoder): カスタムコーダーを使用して、JSON のデコード/エンコードをよりきめ細かく制御します。 この列挙体は、特別な日付形式、タイムゾーン、ロケールを使用する場合などに、独自の JSONEncoder と JSONDecoderを提供する場合にのみ使用してください。 let myEncoder = JSONEncoder() myEncoder.dateFormat = … let myDecoder = JSONDecoder() myDecoder.dateFormat = … let coder: Coder = .custom(myEncoder, myDecoder) デフォルト:.default
構成	FetchConfiguration	オプション。返されるレコード、ページネーションページサイズ制限、取得するフィールド、フィールドに含める内容を定義するフィルターを含む、取得したレコードに適用する構成。 デフォルト:nil - すべてのレコードが返されます。

表 : 28. 戻り値

タイプ	説明
モデル	メソッドが成功したときに返されます。デコード可能なモデル。
NowDataError	メソッドが失敗したときにスローされます。 accessToken(AccessTokenProviderError) AccessTokenProviderError:アクセストークンプロバイダーのエラーコードまたはメッセージ。 アクセストークン回収失敗 userSessionError(_ error: Error) アクセストークンにエラーがある場合にスローされます。 attachmentValidation 添付ファイルが検証に失敗した場合にスローされます。 badResponse (statusCode: HTTPStatusCode) HTTPStatusCode:インスタンスから受信したステータスコード。 要求が予期しない応答を返すとスローされます cannotDecodeModel(デコードエラー) DecodingError:デコードエラーが検出されました。 コード可能なモデルを JSON からデコードできない場合にスローされます。 cannotDecodeProperty(type: Any, from: String) type:文字列からデコードするためのラップされた型。 from:指定したタイプにデコードする文字列。 文字列でラップされた値を JSON からデコードできない場合にスローされます。 cannotEncodeModel(EncodingError) EncodingError:エンコードエラーが検出されました。 コード可能なモデルを JSON にエンコードできない場合にスローされます。 応答を解析できません インスタンスからの応答を想定される形式に解析できない場合にスローされます。 無効なURL URL を形成できない場合にスローされます。たとえば、文字列に URL で無効な文字が含まれている場合や、空の文字列である場合などです。 missingAttachmentMetadata 添付ファイルのメタデータヘッダーがない場合にスローされます。 missingServiceConfiguration 想定されるサービス構成がない場合にスローされます。 missingSysID 想定されるsys_idパラメーターがない場合にスローされます。 ネットワーク (NetworkServiceError) genericError(文字列) operationCanceled サービス無効 serverError(エラー) systemError(エラー) ネットワークサービスでエラーが発生するとスローされます。

次のコード例は、このメソッドを呼び出す方法を示しています。

struct User: Codable { 
    var name: String
} 

let service: NowTableService = ... 
do {
    let result = try await service.model([User].self, from: "sys_user", path: "result")
    print("Fetched \(users.count) users")
} catch {
    dump(error) 
}

次のコード例は、1 つのデコード可能なモデルをsys_idでフェッチする方法を示しています。[User].self ではなく、User.self などの単一のモデルタイプを使用します。

let result = try await service.model(User.self, with: "5137153cc611227c000bbd1bd8cd2005", from: "sys_user", path: "result") 

NowTableService - model<Model: Decodable>(_ type: Model.Type, with sysId: SysID? = nil, from tableName: String, path: String = Constants.resultPath, coder: Coder = .default, configuration: FetchConfiguration? = nil, completion: @escaping (Result<Model, NowDataError>))

指定されたテーブルからデコード可能なモデルを取得します。

テーブル API 応答は、次のような result パラメーター内にネストされます。

{
  "result": [
    { "name": "Ash Williams" },
    { "name": "Lionel Cosgrove" },
    { "name": "Laurie Strode" }
  ]
}

この関数を使用して、ネストされた出力の代わりにデコード可能なモデルを取得します。

表 : 29. パラメーター

名前	タイプ	説明
type	Model.Type	デコードする値のタイプ。
sysId あり	文字列	オプション。返されるレコードの sys_id。 デフォルト: configuration 設定に従って返されるすべてのレコード。
tableName から	文字列	インシデントなどのレコードの取得元のテーブルの名前。
パス	文字列	オプション。ネストされたタイプのドット区切りパス。たとえば、より詳細なネストを行う には、result や foo.bar.baz などです。 デフォルト: Constants.resultPath
コーダー	コーダー	オプション。ServiceNowインスタンスとの間で送受信されるデータのエンコードまたはデコードに使用するコーダー。 デフォルト: .default
構成	FetchConfiguration	オプション。返されるレコード、ページネーションページサイズ制限、取得するフィールド、フィールドに含める内容を定義するフィルターを含む、取得したレコードに適用する構成。 デフォルト:nil - すべてのレコードが返されます。
完了	@escaping (result<model, NowDataError>)	指定されたデコード可能モデルを取得した後に実行する補完ハンドラー。 補完ハンドラーの戻り値: 成功:要求されたモデルタイプのデータ。 エラー:NowDataError accessToken(AccessTokenProviderError) AccessTokenProviderError:アクセストークンプロバイダーのエラーコードまたはメッセージ。 アクセストークン回収失敗 userSessionError(_ error: Error) アクセストークンにエラーがある場合にスローされます。 attachmentValidation 添付ファイルが検証に失敗した場合にスローされます。 badResponse (statusCode: HTTPStatusCode) HTTPStatusCode:インスタンスから受信したステータスコード。 要求が予期しない応答を返すとスローされます cannotDecodeModel(デコードエラー) DecodingError:デコードエラーが検出されました。 コード可能なモデルを JSON からデコードできない場合にスローされます。 cannotDecodeProperty(type: Any, from: String) type:文字列からデコードするためのラップされた型。 from:指定したタイプにデコードする文字列。 文字列でラップされた値を JSON からデコードできない場合にスローされます。 cannotEncodeModel(EncodingError) EncodingError:エンコードエラーが検出されました。 コード可能なモデルを JSON にエンコードできない場合にスローされます。 応答を解析できません インスタンスからの応答を想定される形式に解析できない場合にスローされます。 無効なURL URL を形成できない場合にスローされます。たとえば、文字列に URL で無効な文字が含まれている場合や、空の文字列である場合などです。 missingAttachmentMetadata 添付ファイルのメタデータヘッダーがない場合にスローされます。 missingServiceConfiguration 想定されるサービス構成がない場合にスローされます。 missingSysID 想定されるsys_idパラメーターがない場合にスローされます。 ネットワーク (NetworkServiceError) genericError(文字列) operationCanceled サービス無効 serverError(エラー) systemError(エラー) ネットワークサービスでエラーが発生するとスローされます。

表 : 30. 戻り値

タイプ	説明
なし

デコードされた User モデルのコレクションを取得します。

struct User: SysIdentifiableModel {
    var sysId: String = ""
    var name: String
}
let service: NowTableService = ...
let user = User(name: "Ash Williams")
service.create(Incident(fields: fields), in: tableName, writeOptions: writeOptions, configuration: fetchConfiguration) { [weak self] result in
  switch result {
  case .success(let newUser):
    /// 'newUser' contains the platform assigned 'sys_id', use in subsequent 'update' or 'delete' calls.
  case .failure(let error):
   ...
 }
}

1 つのデコード可能なモデルをsys_idでフェッチするには、[User].self ではなく、User.self などの単一のモデルタイプを使用します。

service.model(User.self, with: "5137153cc611227c000bbd1bd8cd2005", from: "sys_user", path: "result") { resultin ... }

NowTableService - model<Model: Decodable>(sysId: SysID? = nil, from tableName: String, path: String = Constants.resultPath, coder: Coder = .default, configuration: FetchConfiguration? = nil)

指定されたテーブルからデコード可能なモデルを取得できるパブリッシャーを作成します。

注:

このメソッドは廃止されました。代わりに、メソッドの async/await 実装を使用する必要があります。

テーブル API 応答は、次のような result パラメーター内にネストされます。

{
  "result": [
    { "name": "Ash Williams" },
    { "name": "Lionel Cosgrove" },
    { "name": "Laurie Strode" }
  ]
}

結果セットが大きい場合は、ページネーションされたモデルをフェッチするために、 NowTableService - paginator(from tableName: String, configuration: FetchConfiguration? = nil) または NowTableService - paginator<Model: Decodable>(from tableName: String, path: String = Constants.resultPath, coder: Coder = .default, configuration: FetchConfiguration? = nil) のいずれかのページネーション関数を使用します。

表 : 31. パラメーター

名前	タイプ	説明
sysId あり	SysID	オプション。返されるレコードの sys_id。特定のレコードを取得する場合は、sys_idを入力します。 デフォルト:nil
tableName から	文字列	インシデントなどのレコードの取得元のテーブルの名前。
パス	文字列	ネストされたタイプのドット区切りパス。たとえば、より詳細なネストを行う には、result や foo.bar.baz などです。 デフォルト: result
コーダー	コーダー	オプション。ServiceNowインスタンスとの間で送受信されるデータのエンコードまたはデコードに使用するコーダー。 可能な値： default: 既定のエンコーダーは、デバイスの Locale と TimeZone を使用して、yyy-MM-dd HH:mm:ss 形式を使用して日付を書式設定します。 custom(JSONEncoder, JSONDecoder): カスタムコーダーを使用して、JSON のデコード/エンコードをよりきめ細かく制御します。 この列挙体は、特別な日付形式、タイムゾーン、ロケールを使用する場合などに、独自の JSONEncoder と JSONDecoderを提供する場合にのみ使用してください。 let myEncoder = JSONEncoder() myEncoder.dateFormat = … let myDecoder = JSONDecoder() myDecoder.dateFormat = … let coder: Coder = .custom(myEncoder, myDecoder) デフォルト:.default
構成	FetchConfiguration	オプション。返されるレコード、ページネーションページサイズ制限、取得するフィールド、フィールドに含める内容を定義するフィルターを含む、取得したレコードに適用する構成。 デフォルト:nil - すべてのレコードが返されます。

表 : 32. 戻り値

タイプ

説明

AnyPublisher<Model、NowDataError>

成功:パブリッシャーがデコード可能なモデルを返します。 エラー:NowDataError accessToken(AccessTokenProviderError) AccessTokenProviderError:アクセストークンプロバイダーのエラーコードまたはメッセージ。 アクセストークン回収失敗 userSessionError(_ error: Error) アクセストークンにエラーがある場合にスローされます。 attachmentValidation 添付ファイルが検証に失敗した場合にスローされます。 badResponse (statusCode: HTTPStatusCode) HTTPStatusCode:インスタンスから受信したステータスコード。 要求が予期しない応答を返すとスローされます cannotDecodeModel(デコードエラー) DecodingError:デコードエラーが検出されました。 コード可能なモデルを JSON からデコードできない場合にスローされます。 cannotDecodeProperty(type: Any, from: String) type:文字列からデコードするためのラップされた型。 from:指定したタイプにデコードする文字列。 文字列でラップされた値を JSON からデコードできない場合にスローされます。 cannotEncodeModel(EncodingError) EncodingError:エンコードエラーが検出されました。 コード可能なモデルを JSON にエンコードできない場合にスローされます。 応答を解析できません インスタンスからの応答を想定される形式に解析できない場合にスローされます。 無効なURL URL を形成できない場合にスローされます。たとえば、文字列に URL で無効な文字が含まれている場合や、空の文字列である場合などです。 missingAttachmentMetadata 添付ファイルのメタデータヘッダーがない場合にスローされます。 missingServiceConfiguration 想定されるサービス構成がない場合にスローされます。 missingSysID 想定されるsys_idパラメーターがない場合にスローされます。 ネットワーク (NetworkServiceError) genericError(文字列) operationCanceled サービス無効 serverError(エラー) systemError(エラー) ネットワークサービスでエラーが発生するとスローされます。

[ Users].self など、デコードされたユーザーモデルをタイプ別に提供するパブリッシャーを取得するには、ドット区切りパスを指定してモデルをフェッチします。

struct User: Codable {
  varname: String
}

let service: NowTableService = ...
let publisher: AnyPublisher<[User], NowDataError> = service.model(from: "sys_user", path: "user.photos.gps_location")
 

1 つのデコード可能なモデルをsys_idでフェッチするには、[User].self ではなく、単一の User.self モデルタイプを使用します。

let publisher: AnyPublisher<User, NowDataError> = service.model(with: "5137153cc611227c000bbd1bd8cd2005", from: "sys_user", path: "result")

NowTableService - paginator(from tableName: String, configuration: FetchConfiguration? = nil)

レコードのページを反復処理できるようにするページネーションを作成します。

ページネーションの Publisher は、カスタムの Codable モデルにデコードできるデータを出力するか、 NowTableService - paginator<Model: Decodable>(from tableName: String, path: String = Constants.resultPath, coder: Coder = .default, configuration: FetchConfiguration? = nil) 関数を使用することもできます。 または、便利な関数 convertToRecords() を使用して、データを NowRecord オブジェクトに変換することもできます。次に、パブリッシャーを変換して NowRecord を発行する方法を示します。

let dataPublisher: AnyPublisher<Data, NowDataError> = ...
let recordsPublisher: AnyPublisher<[NowRecord], NowDataError> = myPublisher.convertToRecords()

注:

configuration パラメーターで上書きされない限り、ページネーションはページあたり 20 個のアイテムを返します。ACL 評価によっては、1 ページにフェッチされるアイテムの実際の数がデフォルト値または構成値よりも少なくなる場合があります。

表 : 33. パラメーター

名前	タイプ	説明
tableName	文字列	インシデントなどのレコードの取得元のテーブルの名前。
構成	FetchConfiguration	オプション。返されるレコード、ページネーションページサイズ制限、取得するフィールド、フィールドに含める内容を定義するフィルターを含む、取得したレコードに適用する構成。 デフォルト:nil - すべてのレコードが返されます。

表 : 34. 返される内容

タイプ

説明

paginator<data>

成功:指定されたレコードを含むページネーションオブジェクト。 エラー:NowDataError accessToken(AccessTokenProviderError) AccessTokenProviderError:アクセストークンプロバイダーのエラーコードまたはメッセージ。 アクセストークン回収失敗 userSessionError(_ error: Error) アクセストークンにエラーがある場合にスローされます。 attachmentValidation 添付ファイルが検証に失敗した場合にスローされます。 badResponse (statusCode: HTTPStatusCode) HTTPStatusCode:インスタンスから受信したステータスコード。 要求が予期しない応答を返すとスローされます cannotDecodeModel(デコードエラー) DecodingError:デコードエラーが検出されました。 コード可能なモデルを JSON からデコードできない場合にスローされます。 cannotDecodeProperty(type: Any, from: String) type:文字列からデコードするためのラップされた型。 from:指定したタイプにデコードする文字列。 文字列でラップされた値を JSON からデコードできない場合にスローされます。 cannotEncodeModel(EncodingError) EncodingError:エンコードエラーが検出されました。 コード可能なモデルを JSON にエンコードできない場合にスローされます。 応答を解析できません インスタンスからの応答を想定される形式に解析できない場合にスローされます。 無効なURL URL を形成できない場合にスローされます。たとえば、文字列に URL で無効な文字が含まれている場合や、空の文字列である場合などです。 missingAttachmentMetadata 添付ファイルのメタデータヘッダーがない場合にスローされます。 missingServiceConfiguration 想定されるサービス構成がない場合にスローされます。 missingSysID 想定されるsys_idパラメーターがない場合にスローされます。 ネットワーク (NetworkServiceError) genericError(文字列) operationCanceled サービス無効 serverError(エラー) systemError(エラー) ネットワークサービスでエラーが発生するとスローされます。

private var tableService: NowTableService?
// Paginator creation uses type inference to determine the response type.
private var paginator: Paginator<[CustomerServiceCase]>?

func initializeTableService(for instanceUrl: URL) {
  makeTableService(instanceUrl: instanceUrl) { [weak self] result in
    guard let self = self else { return }
            
    switch result {
    case .success(let tableService):
      self.tableService = tableService
      // Create a paginator that iterates over pages of customer support cases. The paginator's response type is
      // inferred from the paginator's type definition (e.g. `Paginator<[CustomerServiceCase]>`).
      self.paginator = tableService.paginator(from: Self.tableName, configuration: self.fetchConfiguration)
      // Subscribe to the paginator's publisher so you are able to receive paged results.
      self.subscribeToPaginatorPublisher()
      // Ready to start fetching data, inform the view controller.
      self.onReady(self)
    case .failure(let error):
      debugPrint("Creating table service failed with error: \(error.localizedDescription)")
      self.tableService = nil
      self.paginator = nil
    }
  }
}

NowTableService - paginator<Model: Decodable>(from tableName: String, path: String = Constants.resultPath, coder: Coder = .default, configuration: FetchConfiguration? = nil)

ネストを処理するデコードされたモデルのページの反復を可能にするページネーションを作成します。

ServiceNow REST Table API 応答は、次のような結果プロパティ内にネストされます。

{
  "result": [
    { "name": "Ash Williams" },
    { "name": "Lionel Cosgrove" },
    { "name": "Laurie Strode" }
  ]
}

デコードされたユーザーモデルを提供するページネータを取得するには、ドット区切りのパスを指定してページネータをフェッチします。この場合は、 resultです。

struct User: Codable {
  varname: String
}

let service: NowTableService = ...
let paginator: Paginator<[User]> = service.paginator(from: "sys_user", path: "result")

注:

configuration パラメーターで上書きされない限り、ページネーションはページあたり 20 個のアイテムを返します。ACL 評価によっては、1 ページにフェッチされる実際のアイテムの数がデフォルト値または構成値よりも少なくなる場合があります。

Paginator オブジェクトを取得したら、その Combine Publisher をサブスクライブしてデータの受信を開始します。

paginator.publisher
  .subscribe(on: DispatchQueue.global())
  .receive(on: DispatchQueue.main)
  .sink { … }
  .store(in: &subscriptions)

注:

すべての Combine サブスクリプションと同様に、予期しない結果を避けるために、サブスクリプションを保持するようにしてください。

表 : 35. パラメーター

名前	タイプ	説明
tableName から	文字列	インシデントなどのレコードの取得元のテーブルの名前。
path	文字列	ネストされたタイプのドット区切りパス。たとえば、より詳細なネストを行う には、result または result.user.photos を使用します。カスタムパスを指定すると、ネストされたデータのフェッチまたは反復処理が可能になります。 デフォルト: result
コーダー	コーダー	オプション。ServiceNowインスタンスとの間で送受信されるデータのエンコードまたはデコードに使用するコーダー。 可能な値： default: 既定のエンコーダーは、デバイスの Locale と TimeZone を使用して、yyy-MM-dd HH:mm:ss 形式を使用して日付を書式設定します。 custom(JSONEncoder, JSONDecoder): カスタムコーダーを使用して、JSON のデコード/エンコードをよりきめ細かく制御します。 この列挙体は、特別な日付形式、タイムゾーン、ロケールを使用する場合などに、独自の JSONEncoder と JSONDecoderを提供する場合にのみ使用してください。 let myEncoder = JSONEncoder() myEncoder.dateFormat = … let myDecoder = JSONDecoder() myDecoder.dateFormat = … let coder: Coder = .custom(myEncoder, myDecoder) デフォルト:.default
構成	FetchConfiguration	オプション。返されるレコード、ページネーションページサイズ制限、取得するフィールド、フィールドに含める内容を定義するフィルターを含む、取得したレコードに適用する構成。 デフォルト:nil - すべてのレコードが返されます。

表 : 36. 戻り値

タイプ

説明

paginator<data>

成功:ページ化された デコード可能 モデルを含むページネーションオブジェクト。 エラー:NowDataError accessToken(AccessTokenProviderError) AccessTokenProviderError:アクセストークンプロバイダーのエラーコードまたはメッセージ。 アクセストークン回収失敗 userSessionError(_ error: Error) アクセストークンにエラーがある場合にスローされます。 attachmentValidation 添付ファイルが検証に失敗した場合にスローされます。 badResponse (statusCode: HTTPStatusCode) HTTPStatusCode:インスタンスから受信したステータスコード。 要求が予期しない応答を返すとスローされます cannotDecodeModel(デコードエラー) DecodingError:デコードエラーが検出されました。 コード可能なモデルを JSON からデコードできない場合にスローされます。 cannotDecodeProperty(type: Any, from: String) type:文字列からデコードするためのラップされた型。 from:指定したタイプにデコードする文字列。 文字列でラップされた値を JSON からデコードできない場合にスローされます。 cannotEncodeModel(EncodingError) EncodingError:エンコードエラーが検出されました。 コード可能なモデルを JSON にエンコードできない場合にスローされます。 応答を解析できません インスタンスからの応答を想定される形式に解析できない場合にスローされます。 無効なURL URL を形成できない場合にスローされます。たとえば、文字列に URL で無効な文字が含まれている場合や、空の文字列である場合などです。 missingAttachmentMetadata 添付ファイルのメタデータヘッダーがない場合にスローされます。 missingServiceConfiguration 想定されるサービス構成がない場合にスローされます。 missingSysID 想定されるsys_idパラメーターがない場合にスローされます。 ネットワーク (NetworkServiceError) genericError(文字列) operationCanceled サービス無効 serverError(エラー) systemError(エラー) ネットワークサービスでエラーが発生するとスローされます。

この例では、デコードされたユーザー モデルを提供する Paginator オブジェクトを取得する方法を説明します。目的の Paginator オブジェクトをフェッチするには、User モデルのコレクション ([User]) を返すようにコンパイラにヒントを与え、ユーザーが結果パスの下にネストされていることを Paginator オブジェクトに通知します。

struct User: Codable {
  var name: String
}

let service: NowTableService = ...
let paginator: Paginator<[User]> = service.paginator(from: "sys_user", path: "result")

注:

Table API は常に結果パスの下にネストされた結果を返すため、path パラメーターを安全に削除できます。

NowTableService - record(with sysId: SysID, from tableName: String, configuration: FieldReadConfiguration? = nil) 非同期はスローします

ServiceNowインスタンスの指定されたテーブルから指定されたレコードを取得します。

Publisher は、カスタムの Codable モデルにデコードできるデータを出力するか、 NowTableService - paginator<Model: Decodable>(from tableName: String, path: String = Constants.resultPath, coder: Coder = .default, configuration: FetchConfiguration? = nil) 関数を使用することもできます。 または、便利な関数 convertToRecords() を使用して、データを NowRecord オブジェクトに変換することもできます。次に、パブリッシャーを変換して NowRecord を発行する方法を示します。。

let dataPublisher: AnyPublisher<Data, NowDataError> = ...
let recordsPublisher: AnyPublisher<[NowRecord], NowDataError> = myPublisher.convertToRecords()

表 : 37. パラメーター

名前	タイプ	説明
sysId	文字列	ServiceNowインスタンスから返されるレコードのSys_id。
tableName から	文字列	インシデントなどのレコードの取得元のテーブルの名前。
構成	FetchConfiguration	オプション。返されるレコード、ページネーションページサイズ制限、取得するフィールド、フィールドに含める内容を定義するフィルターを含む、取得したレコードに適用する構成。 デフォルト:nil - すべてのレコードが返されます。

表 : 38. 返される内容

タイプ	説明
データ	メソッドが成功したときに返されます。指定されたレコードを含むデータオブジェクト。
NowDataError	メソッドが失敗したときにスローされます。 accessToken(AccessTokenProviderError) AccessTokenProviderError:アクセストークンプロバイダーのエラーコードまたはメッセージ。 アクセストークン回収失敗 userSessionError(_ error: Error) アクセストークンにエラーがある場合にスローされます。 attachmentValidation 添付ファイルが検証に失敗した場合にスローされます。 badResponse (statusCode: HTTPStatusCode) HTTPStatusCode:インスタンスから受信したステータスコード。 要求が予期しない応答を返すとスローされます cannotDecodeModel(デコードエラー) DecodingError:デコードエラーが検出されました。 コード可能なモデルを JSON からデコードできない場合にスローされます。 cannotDecodeProperty(type: Any, from: String) type:文字列からデコードするためのラップされた型。 from:指定したタイプにデコードする文字列。 文字列でラップされた値を JSON からデコードできない場合にスローされます。 cannotEncodeModel(EncodingError) EncodingError:エンコードエラーが検出されました。 コード可能なモデルを JSON にエンコードできない場合にスローされます。 応答を解析できません インスタンスからの応答を想定される形式に解析できない場合にスローされます。 無効なURL URL を形成できない場合にスローされます。たとえば、文字列に URL で無効な文字が含まれている場合や、空の文字列である場合などです。 missingAttachmentMetadata 添付ファイルのメタデータヘッダーがない場合にスローされます。 missingServiceConfiguration 想定されるサービス構成がない場合にスローされます。 missingSysID 想定されるsys_idパラメーターがない場合にスローされます。 ネットワーク (NetworkServiceError) genericError(文字列) operationCanceled サービス無効 serverError(エラー) systemError(エラー) ネットワークサービスでエラーが発生するとスローされます。

次のコード例は、このメソッドを呼び出す方法を示しています。

func fetchTableRecord(sysId: String, tableName: String, includeFields: [FieldName] = [FieldName](), readOptions: FieldReadConfiguration.Options = []) async throws -> NowRecord {
    let readConfig = FieldReadConfiguration(includeFields: includeFields, options: readOptions)
    do {
        let dataResult: Data = try await tableService.record(with: sysId, from: tableName, configuration: configuration)
        let recordResult: NowRecord = dataResult.convertToRecord()
        return recordResult
    } catch {
        print("Fetch failed with NowDataError: \(error)")
        throw error
    }
}

NowTableService - record(with sysId: SysID, from tableName: String, configuration: FieldReadConfiguration, completion: @escaping (Result<Data, NowDataError>)

指定されたテーブルから指定されたレコードを取得し、レコードを取得した後に補完ハンドラーを実行します。

必要に応じて、返された結果をカスタムの Codable モデルにデコードするか、代わりに関数 NowTableService - paginator<Model: Decodable>(from tableName: String, path: String = Constants.resultPath, coder: Coder = .default, configuration: FetchConfiguration? = nil) を使用できます。 または、便利な関数 convertToRecords() を使用して、データを NowRecord オブジェクトに変換することもできます。次に、パブリッシャーを変換して NowRecord を発行する方法を示します。

let dataPublisher: AnyPublisher<Data, NowDataError> = ...
let recordsPublisher: AnyPublisher<[NowRecord], NowDataError> = myResult.convertToRecords()

結果セットが大きい場合は、 NowTableService - paginator(from tableName: String, configuration: FetchConfiguration? = nil) 関数を使用してページネーションされた結果をフェッチします。

表 : 39. パラメーター

名前	タイプ	説明
sysId	文字列	ServiceNowインスタンスから返されるレコードのSys_id。
tableName から	文字列	インシデントなどのレコードの取得元のテーブルの名前。
構成	FetchConfiguration	オプション。返されるレコード、ページネーションページサイズ制限、取得するフィールド、フィールドに含める内容を定義するフィルターを含む、取得したレコードに適用する構成。 デフォルト:nil - すべてのレコードが返されます。
完了	@escaping (result<data, NowDataError>)	レコードが取得された後に実行する補完ハンドラー。 戻り値: 成功:データ:要求されたレコード エラー:NowDataError accessToken(AccessTokenProviderError) AccessTokenProviderError:アクセストークンプロバイダーのエラーコードまたはメッセージ。 アクセストークン回収失敗 userSessionError(_ error: Error) アクセストークンにエラーがある場合にスローされます。 attachmentValidation 添付ファイルが検証に失敗した場合にスローされます。 badResponse (statusCode: HTTPStatusCode) HTTPStatusCode:インスタンスから受信したステータスコード。 要求が予期しない応答を返すとスローされます cannotDecodeModel(デコードエラー) DecodingError:デコードエラーが検出されました。 コード可能なモデルを JSON からデコードできない場合にスローされます。 cannotDecodeProperty(type: Any, from: String) type:文字列からデコードするためのラップされた型。 from:指定したタイプにデコードする文字列。 文字列でラップされた値を JSON からデコードできない場合にスローされます。 cannotEncodeModel(EncodingError) EncodingError:エンコードエラーが検出されました。 コード可能なモデルを JSON にエンコードできない場合にスローされます。 応答を解析できません インスタンスからの応答を想定される形式に解析できない場合にスローされます。 無効なURL URL を形成できない場合にスローされます。たとえば、文字列に URL で無効な文字が含まれている場合や、空の文字列である場合などです。 missingAttachmentMetadata 添付ファイルのメタデータヘッダーがない場合にスローされます。 missingServiceConfiguration 想定されるサービス構成がない場合にスローされます。 missingSysID 想定されるsys_idパラメーターがない場合にスローされます。 ネットワーク (NetworkServiceError) genericError(文字列) operationCanceled サービス無効 serverError(エラー) systemError(エラー) ネットワークサービスでエラーが発生するとスローされます。

表 : 40. 返される内容

タイプ	説明
なし

次のコード例は、このメソッドを呼び出す方法を示しています。

func fetchTableRecords( tableName: String, filterQuery: String, includeFields: [FieldName] = [FieldName](), readOptions: FieldReadConfiguration.Options = [], limit: Int?) {
  let readConfig = FieldReadConfiguration(includeFields: includeFields, options: readOptions)
  let config = FetchConfiguration(Filter(query: filterQuery), limit, readConfig)
  tableService.records (from: tableName, configuration: fetchConfiguration) { [weak self] result in
    switch result {
      case .success(let dataResult):
        let recordResult: [NowRecord] = dataResult.convertToRecords()
        // Return recordResult

      case .failure(let error):
        // Failed to fetch record with NowDataError
    }
  }
}

NowTableService - record(sysId:SysID, from tableName:String, configuration: FieldReadConfiguration? = nil)

ServiceNowインスタンス上の指定されたテーブルから指定されたレコードを取得するパブリッシャーを作成します。

注:

このメソッドは廃止されました。代わりに、メソッドの async/await 実装を使用する必要があります。

Publisher は、カスタムの Codable モデルにデコードできるデータを出力するか、 NowTableService - paginator<Model: Decodable>(from tableName: String, path: String = Constants.resultPath, coder: Coder = .default, configuration: FetchConfiguration? = nil) 関数を使用することもできます。 または、便利な関数 convertToRecords() を使用して、データを NowRecord オブジェクトに変換することもできます。次に、パブリッシャーを変換して NowRecord を発行する方法を示します。。

let dataPublisher: AnyPublisher<Data, NowDataError> = ...
let recordsPublisher: AnyPublisher<[NowRecord], NowDataError> = myPublisher.convertToRecords()

表 : 41. パラメーター

名前	タイプ	説明
sysId	文字列	ServiceNowインスタンスから返されるレコードのSys_id。
tableName から	文字列	インシデントなどのレコードの取得元のテーブルの名前。
構成	FetchConfiguration	オプション。返されるレコード、ページネーションページサイズ制限、取得するフィールド、フィールドに含める内容を定義するフィルターを含む、取得したレコードに適用する構成。 デフォルト:nil - すべてのレコードが返されます。

表 : 42. 返される内容

タイプ

説明

AnyPublisher<Data、NowDataError>

成功:指定されたレコードを含むデータオブジェクト。 エラー:NowDataError accessToken(AccessTokenProviderError) AccessTokenProviderError:アクセストークンプロバイダーのエラーコードまたはメッセージ。 アクセストークン回収失敗 userSessionError(_ error: Error) アクセストークンにエラーがある場合にスローされます。 attachmentValidation 添付ファイルが検証に失敗した場合にスローされます。 badResponse (statusCode: HTTPStatusCode) HTTPStatusCode:インスタンスから受信したステータスコード。 要求が予期しない応答を返すとスローされます cannotDecodeModel(デコードエラー) DecodingError:デコードエラーが検出されました。 コード可能なモデルを JSON からデコードできない場合にスローされます。 cannotDecodeProperty(type: Any, from: String) type:文字列からデコードするためのラップされた型。 from:指定したタイプにデコードする文字列。 文字列でラップされた値を JSON からデコードできない場合にスローされます。 cannotEncodeModel(EncodingError) EncodingError:エンコードエラーが検出されました。 コード可能なモデルを JSON にエンコードできない場合にスローされます。 応答を解析できません インスタンスからの応答を想定される形式に解析できない場合にスローされます。 無効なURL URL を形成できない場合にスローされます。たとえば、文字列に URL で無効な文字が含まれている場合や、空の文字列である場合などです。 missingAttachmentMetadata 添付ファイルのメタデータヘッダーがない場合にスローされます。 missingServiceConfiguration 想定されるサービス構成がない場合にスローされます。 missingSysID 想定されるsys_idパラメーターがない場合にスローされます。 ネットワーク (NetworkServiceError) genericError(文字列) operationCanceled サービス無効 serverError(エラー) systemError(エラー) ネットワークサービスでエラーが発生するとスローされます。

この例では、指定されたフィールドを使用して、指定されたテーブルから指定されたレコードを取得する関数を作成する方法を示します。呼び出しの出力は ByteArray で、データを任意のモデルに変換できます。

tableService.record(with: sysId, from: tableName, configuration: fetchConfiguration)
    .subscribe(on: DispatchQueue.global())
    .receive(on: DispatchQueue.main)
    .convertToRecord()
    .sink { completion in
        if case let .failure(error) = completion {
            print("Record retrieval failed with NowDataError: \(error)")
        }
    } receiveValue: { record in
        print("Successfully retrieved record: \(record)")
    }
    .store(in: &subscriptions)

NowTableService - records(from tableName: String, configuration: FetchConfiguration? = nil) async throws

指定されたテーブルからレコードを取得します。

ザ Publisher は、カスタムの Codable モデルにデコードできるデータを出力するか、 NowTableService - paginator<Model: Decodable>(from tableName: String, path: String = Constants.resultPath, coder: Coder = .default, configuration: FetchConfiguration? = nil) 関数を使用することもできます。 または、便利な関数 convertToRecords() を使用して、データを NowRecord オブジェクトに変換することもできます。次に、パブリッシャーを変換して NowRecord を発行する方法を示します。

let dataPublisher: AnyPublisher<Data, NowDataError> = ...
let recordsPublisher: AnyPublisher<[NowRecord], NowDataError> = myPublisher.convertToRecords()

結果セットが大きい場合は、 NowTableService - paginator(from tableName: String, configuration: FetchConfiguration? = nil) 関数を使用してページネーションされた結果をフェッチします。

表 : 43. パラメーター

名前	タイプ	説明
tableName から	文字列	インシデントなどのレコードの取得元のテーブルの名前。
構成	FetchConfiguration	オプション。返されるレコード、ページネーションページサイズ制限、取得するフィールド、フィールドに含める内容を定義するフィルターを含む、取得したレコードに適用する構成。 デフォルト:nil - すべてのレコードが返されます。

表 : 44. 返される内容

タイプ	説明
データ	メソッドが成功したときに返されます。指定されたレコードを含むデータオブジェクト。
NowDataError	メソッドが失敗したときにスローされます。 accessToken(AccessTokenProviderError) AccessTokenProviderError:アクセストークンプロバイダーのエラーコードまたはメッセージ。 アクセストークン回収失敗 userSessionError(_ error: Error) アクセストークンにエラーがある場合にスローされます。 attachmentValidation 添付ファイルが検証に失敗した場合にスローされます。 badResponse (statusCode: HTTPStatusCode) HTTPStatusCode:インスタンスから受信したステータスコード。 要求が予期しない応答を返すとスローされます cannotDecodeModel(デコードエラー) DecodingError:デコードエラーが検出されました。 コード可能なモデルを JSON からデコードできない場合にスローされます。 cannotDecodeProperty(type: Any, from: String) type:文字列からデコードするためのラップされた型。 from:指定したタイプにデコードする文字列。 文字列でラップされた値を JSON からデコードできない場合にスローされます。 cannotEncodeModel(EncodingError) EncodingError:エンコードエラーが検出されました。 コード可能なモデルを JSON にエンコードできない場合にスローされます。 応答を解析できません インスタンスからの応答を想定される形式に解析できない場合にスローされます。 無効なURL URL を形成できない場合にスローされます。たとえば、文字列に URL で無効な文字が含まれている場合や、空の文字列である場合などです。 missingAttachmentMetadata 添付ファイルのメタデータヘッダーがない場合にスローされます。 missingServiceConfiguration 想定されるサービス構成がない場合にスローされます。 missingSysID 想定されるsys_idパラメーターがない場合にスローされます。 ネットワーク (NetworkServiceError) genericError(文字列) operationCanceled サービス無効 serverError(エラー) systemError(エラー) ネットワークサービスでエラーが発生するとスローされます。

次のコード例は、このメソッドを呼び出す方法を示しています。

func fetchTableRecords( tableName: String, filterQuery: String,
 includeFields: [FieldName] = [FieldName](), readOptions:
 FieldReadConfiguration.Options = [], limit: Int?) {
    let readConfig = FieldReadConfiguration(includeFields: includeFields, options: readOptions)
    let config = FetchConfiguration(Filter(query: filterQuery), limit, readConfig)
    do {
      let dataResult: Data = try await tableService.records(from: tableName, configuration: config)
      let recordResult: [NowRecord] = dataResult.convertToRecords()
      // return recordResult
    } catch {
      print("Fetch failed with NowDataError: \(error)")
      throw error 
  }
}

NowTableService - records(from tableName: String, configuration: FetchConfiguration? = nil, completion: @escaping (Result<Data, NowDataError>))

指定されたテーブルからレコードを取得し、レコードを取得した後に completion ハンドラーを実行します。

必要に応じて、返された結果をカスタムの Codable モデルにデコードするか、代わりに関数 NowTableService - paginator<Model: Decodable>(from tableName: String, path: String = Constants.resultPath, coder: Coder = .default, configuration: FetchConfiguration? = nil) を使用できます。 または、便利な関数 convertToRecords() を使用して、データを NowRecord オブジェクトに変換することもできます。次に、パブリッシャーを変換して NowRecord を発行する方法を示します。

let dataPublisher: AnyPublisher<Data, NowDataError> = ...
let recordsPublisher: AnyPublisher<[NowRecord], NowDataError> = myResult.convertToRecords()

結果セットが大きい場合は、 NowTableService - paginator(from tableName: String, configuration: FetchConfiguration? = nil) 関数を使用してページネーションされた結果をフェッチします。

表 : 45. パラメーター

名前	タイプ	説明
tableName で	文字列	インシデントなどのレコードを書き込むテーブルの名前。
構成	FetchConfiguration	オプション。返されるレコード、ページネーションページサイズ制限、取得するフィールド、フィールドに含める内容を定義するフィルターを含む、取得したレコードに適用する構成。 デフォルト:nil - すべてのレコードが返されます。
完了	@escaping (result<data, NowDataError>)	レコードが取得された後に実行する補完ハンドラー。 戻り値: 成功:データ:要求されたレコード エラー:NowDataError accessToken(AccessTokenProviderError) AccessTokenProviderError:アクセストークンプロバイダーのエラーコードまたはメッセージ。 アクセストークン回収失敗 userSessionError(_ error: Error) アクセストークンにエラーがある場合にスローされます。 attachmentValidation 添付ファイルが検証に失敗した場合にスローされます。 badResponse (statusCode: HTTPStatusCode) HTTPStatusCode:インスタンスから受信したステータスコード。 要求が予期しない応答を返すとスローされます cannotDecodeModel(デコードエラー) DecodingError:デコードエラーが検出されました。 コード可能なモデルを JSON からデコードできない場合にスローされます。 cannotDecodeProperty(type: Any, from: String) type:文字列からデコードするためのラップされた型。 from:指定したタイプにデコードする文字列。 文字列でラップされた値を JSON からデコードできない場合にスローされます。 cannotEncodeModel(EncodingError) EncodingError:エンコードエラーが検出されました。 コード可能なモデルを JSON にエンコードできない場合にスローされます。 応答を解析できません インスタンスからの応答を想定される形式に解析できない場合にスローされます。 無効なURL URL を形成できない場合にスローされます。たとえば、文字列に URL で無効な文字が含まれている場合や、空の文字列である場合などです。 missingAttachmentMetadata 添付ファイルのメタデータヘッダーがない場合にスローされます。 missingServiceConfiguration 想定されるサービス構成がない場合にスローされます。 missingSysID 想定されるsys_idパラメーターがない場合にスローされます。 ネットワーク (NetworkServiceError) genericError(文字列) operationCanceled サービス無効 serverError(エラー) systemError(エラー) ネットワークサービスでエラーが発生するとスローされます。

表 : 46. 返される内容

タイプ	説明
なし

次のコード例は、このメソッドを呼び出す方法を示しています。

func fetchTableRecords( tableName: String, filterQuery: String, includeFields: [FieldName] = [FieldName](), readOptions: FieldReadConfiguration.Options = [], limit: Int?) {
  let readConfig = FieldReadConfiguration(includeFields: includeFields, options: readOptions)
  let config = FetchConfiguration(Filter(query: filterQuery), limit, readConfig)
  tableService.records (from: tableName, configuration: fetchConfiguration) { [weak self] result in
    switch result {
      case .success(let dataResult):
        let recordResult: [NowRecord] = dataResult.convertToRecords()
        // return recordResult

      case .failure(let error):
        // Failed to fetch record with NowDataError
    }
  }
}

NowTableService - records(from tableName: String, configuration: FetchConfiguration? = nil)

指定したテーブルからレコードを取得できるパブリッシャーを作成します。

注:

このメソッドは廃止されました。代わりに、メソッドの async/await 実装を使用する必要があります。

ザ Publisher は、カスタムの Codable モデルにデコードできるデータを出力するか、 NowTableService - paginator<Model: Decodable>(from tableName: String, path: String = Constants.resultPath, coder: Coder = .default, configuration: FetchConfiguration? = nil) 関数を使用することもできます。 または、便利な関数 convertToRecords() を使用して、データを NowRecord オブジェクトに変換することもできます。次に、パブリッシャーを変換して NowRecord を発行する方法を示します。

let dataPublisher: AnyPublisher<Data, NowDataError> = ...
let recordsPublisher: AnyPublisher<[NowRecord], NowDataError> = myPublisher.convertToRecords()

結果セットが大きい場合は、 NowTableService - paginator(from tableName: String, configuration: FetchConfiguration? = nil) 関数を使用してページネーションされた結果をフェッチします。

表 : 47. パラメーター

名前	タイプ	説明
tableName から	文字列	インシデントなどのレコードの取得元のテーブルの名前。
構成	FetchConfiguration	オプション。返されるレコード、ページネーションページサイズ制限、取得するフィールド、フィールドに含める内容を定義するフィルターを含む、取得したレコードに適用する構成。 デフォルト:nil - すべてのレコードが返されます。

表 : 48. 返される内容

タイプ

説明

AnyPublisher<Data、NowDataError>

成功:指定されたレコードを含むデータオブジェクト。 エラー:NowDataError accessToken(AccessTokenProviderError) AccessTokenProviderError:アクセストークンプロバイダーのエラーコードまたはメッセージ。 アクセストークン回収失敗 userSessionError(_ error: Error) アクセストークンにエラーがある場合にスローされます。 attachmentValidation 添付ファイルが検証に失敗した場合にスローされます。 badResponse (statusCode: HTTPStatusCode) HTTPStatusCode:インスタンスから受信したステータスコード。 要求が予期しない応答を返すとスローされます cannotDecodeModel(デコードエラー) DecodingError:デコードエラーが検出されました。 コード可能なモデルを JSON からデコードできない場合にスローされます。 cannotDecodeProperty(type: Any, from: String) type:文字列からデコードするためのラップされた型。 from:指定したタイプにデコードする文字列。 文字列でラップされた値を JSON からデコードできない場合にスローされます。 cannotEncodeModel(EncodingError) EncodingError:エンコードエラーが検出されました。 コード可能なモデルを JSON にエンコードできない場合にスローされます。 応答を解析できません インスタンスからの応答を想定される形式に解析できない場合にスローされます。 無効なURL URL を形成できない場合にスローされます。たとえば、文字列に URL で無効な文字が含まれている場合や、空の文字列である場合などです。 missingAttachmentMetadata 添付ファイルのメタデータヘッダーがない場合にスローされます。 missingServiceConfiguration 想定されるサービス構成がない場合にスローされます。 missingSysID 想定されるsys_idパラメーターがない場合にスローされます。 ネットワーク (NetworkServiceError) genericError(文字列) operationCanceled サービス無効 serverError(エラー) systemError(エラー) ネットワークサービスでエラーが発生するとスローされます。

この例では、指定されたテーブルから複数のレコードをフェッチする関数を作成する方法を示します。これは、将来のある時点で実行される要求をスケジュールし、ByteArray 応答を返すオブジェクトを作成します。

tableService.records(from: tableName, configuration: fetchConfiguration)
    .subscribe(on: DispatchQueue.global())
    .receive(on: DispatchQueue.main)
    .convertToRecords()
    .sink { completion in
        if case let .failure(error) = completion {
            print("Record retrieval failed with NowDataError: \(error)")
        }
    } receiveValue: { records in
        print("Successfully retrieved records: \(records)")
    }
    .store(in: &subscriptions)

NowTableService - update<Model: SysIdentifiableModel>(_ model: Model, in tableName: String, coder: Coder = .default, writeOptions: FieldWriteOptions? = nil, configuration: FetchConfiguration? = nil) async throws

指定されたテーブル内の指定されたコード化可能なモデルを更新します。

表 : 49. パラメーター

名前	タイプ	説明
モデル	モデル	テーブル内の更新する SysIdentifiableModel モデル。
tableName で	文字列	インシデントなどのレコードを書き込むテーブルの名前。
コーダー	コーダー	オプション。ServiceNowインスタンスとの間で送受信されるデータのエンコードまたはデコードに使用するコーダー。 可能な値： default: 既定のエンコーダーは、デバイスの Locale と TimeZone を使用して、yyy-MM-dd HH:mm:ss 形式を使用して日付を書式設定します。 custom(JSONEncoder, JSONDecoder): カスタムコーダーを使用して、JSON のデコード/エンコードをよりきめ細かく制御します。 この列挙体は、特別な日付形式、タイムゾーン、ロケールを使用する場合などに、独自の JSONEncoder と JSONDecoderを提供する場合にのみ使用してください。 let myEncoder = JSONEncoder() myEncoder.dateFormat = … let myDecoder = JSONDecoder() myDecoder.dateFormat = … let coder: Coder = .custom(myEncoder, myDecoder) デフォルト:.default
writeOptions	FieldWriteOptions	オプション。レコードに書き込まれるデータに適用する構成オプション。 デフォルト:nil
構成	FetchConfiguration	オプション。返されるレコード、ページネーションページサイズ制限、取得するフィールド、フィールドに含める内容を定義するフィルターを含む、取得したレコードに適用する構成。 デフォルト:nil - すべてのレコードが返されます。

表 : 50. 戻り値

タイプ	説明
モデル	メソッドが成功したときに返されます。指定されたテーブルで更新されたデコード可能なモデル。
NowDataError	メソッドが失敗したときにスローされます。 accessToken(AccessTokenProviderError) AccessTokenProviderError:アクセストークンプロバイダーのエラーコードまたはメッセージ。 アクセストークン回収失敗 userSessionError(_ error: Error) アクセストークンにエラーがある場合にスローされます。 attachmentValidation 添付ファイルが検証に失敗した場合にスローされます。 badResponse (statusCode: HTTPStatusCode) HTTPStatusCode:インスタンスから受信したステータスコード。 要求が予期しない応答を返すとスローされます cannotDecodeModel(デコードエラー) DecodingError:デコードエラーが検出されました。 コード可能なモデルを JSON からデコードできない場合にスローされます。 cannotDecodeProperty(type: Any, from: String) type:文字列からデコードするためのラップされた型。 from:指定したタイプにデコードする文字列。 文字列でラップされた値を JSON からデコードできない場合にスローされます。 cannotEncodeModel(EncodingError) EncodingError:エンコードエラーが検出されました。 コード可能なモデルを JSON にエンコードできない場合にスローされます。 応答を解析できません インスタンスからの応答を想定される形式に解析できない場合にスローされます。 無効なURL URL を形成できない場合にスローされます。たとえば、文字列に URL で無効な文字が含まれている場合や、空の文字列である場合などです。 missingAttachmentMetadata 添付ファイルのメタデータヘッダーがない場合にスローされます。 missingServiceConfiguration 想定されるサービス構成がない場合にスローされます。 missingSysID 想定されるsys_idパラメーターがない場合にスローされます。 ネットワーク (NetworkServiceError) genericError(文字列) operationCanceled サービス無効 serverError(エラー) systemError(エラー) ネットワークサービスでエラーが発生するとスローされます。

次のコード例は、このメソッドを呼び出す方法を示しています。

struct User: SysIdentifiableModel {
    var sysId: String = ""
    var name: String}
     
func updateUser(user: User) async throws -> User {
    do {
        let result = try await tableService.update(user, in: “sys_user”)
        return result
    } catch {
        print("Update failed with NowDataError: \(error)")
        throw error
    }
}

NowTableService - update<Model: SysIdentifiableModel>(_ model: Model, in tableName: String, coder: Coder = .default, writeOptions: FieldWriteOptions? = nil, configuration: FetchConfiguration? = nil, completion: @escaping (Result<Model, NowDataError>))

指定されたテーブル内の指定されたコード化可能なモデルを更新し、 completion ハンドラーを実行します。

表 : 51. パラメーター

名前	タイプ	説明
モデル	モデル	テーブル内の更新する SysIdentifiableModel モデル。
tableName で	文字列	インシデントなどのレコードを書き込むテーブルの名前。
コーダー	コーダー	オプション。ServiceNowインスタンスとの間で送受信されるデータのエンコードまたはデコードに使用するコーダー。 可能な値： default: 既定のエンコーダーは、デバイスの Locale と TimeZone を使用して、yyy-MM-dd HH:mm:ss 形式を使用して日付を書式設定します。 custom(JSONEncoder, JSONDecoder): カスタムコーダーを使用して、JSON のデコード/エンコードをよりきめ細かく制御します。 この列挙体は、特別な日付形式、タイムゾーン、ロケールを使用する場合などに、独自の JSONEncoder と JSONDecoderを提供する場合にのみ使用してください。 let myEncoder = JSONEncoder() myEncoder.dateFormat = … let myDecoder = JSONDecoder() myDecoder.dateFormat = … let coder: Coder = .custom(myEncoder, myDecoder) デフォルト:.default
writeOptions	FieldWriteOptions	オプション。レコードに書き込まれるデータに適用する構成オプション。 デフォルト:nil
構成	FetchConfiguration	オプション。返されるレコード、ページネーションページサイズ制限、取得するフィールド、フィールドに含める内容を定義するフィルターを含む、取得したレコードに適用する構成。 デフォルト:nil - すべてのレコードが返されます。
完了	@escaping (result<model, NowDataError>)	指定されたコード可能モデルの更新後に実行する補完ハンドラー。 戻り値: 成功:モデル エラー:NowDataError accessToken(AccessTokenProviderError) AccessTokenProviderError:アクセストークンプロバイダーのエラーコードまたはメッセージ。 アクセストークン回収失敗 userSessionError(_ error: Error) アクセストークンにエラーがある場合にスローされます。 attachmentValidation 添付ファイルが検証に失敗した場合にスローされます。 badResponse (statusCode: HTTPStatusCode) HTTPStatusCode:インスタンスから受信したステータスコード。 要求が予期しない応答を返すとスローされます cannotDecodeModel(デコードエラー) DecodingError:デコードエラーが検出されました。 コード可能なモデルを JSON からデコードできない場合にスローされます。 cannotDecodeProperty(type: Any, from: String) type:文字列からデコードするためのラップされた型。 from:指定したタイプにデコードする文字列。 文字列でラップされた値を JSON からデコードできない場合にスローされます。 cannotEncodeModel(EncodingError) EncodingError:エンコードエラーが検出されました。 コード可能なモデルを JSON にエンコードできない場合にスローされます。 応答を解析できません インスタンスからの応答を想定される形式に解析できない場合にスローされます。 無効なURL URL を形成できない場合にスローされます。たとえば、文字列に URL で無効な文字が含まれている場合や、空の文字列である場合などです。 missingAttachmentMetadata 添付ファイルのメタデータヘッダーがない場合にスローされます。 missingServiceConfiguration 想定されるサービス構成がない場合にスローされます。 missingSysID 想定されるsys_idパラメーターがない場合にスローされます。 ネットワーク (NetworkServiceError) genericError(文字列) operationCanceled サービス無効 serverError(エラー) systemError(エラー) ネットワークサービスでエラーが発生するとスローされます。

表 : 52. 戻り値

タイプ	説明
なし

次のコード例は、このメソッドを呼び出す方法を示しています。

struct User: SysIdentifiableModel {
  var sysId: String = ""
  var name: String
}

let user = User(sysId: "12345", name: "abel")
let coder: Coder = .default

tableService.update(user, in: "sys_user") { [weak self] result in
  switch result {
    case .success(let model):
      do {
        let data = try coder.jsonEncoder.encode(model)
        self?.publish(data: data)
      } catch {
        self?.publish(result: .failure(error))
      }            
    case .failure(let error):
      // Failed to update with NowDataError
      self?.publish(result: .failure(error))
  }
}

NowTableService - update<Model: SysIdentifiableModel>(_ model: Model, in tableName: String, coder: Coder = .default, writeOptions: FieldWriteOptions? = nil, configuration: FetchConfiguration? = nil)

指定されたテーブル内の指定されたコード化可能なモデルを更新します。

注:

このメソッドは廃止されました。代わりに、メソッドの async/await 実装を使用する必要があります。

表 : 53. パラメーター

名前	タイプ	説明
モデル	モデル	テーブル内の更新する SysIdentifiableModel モデル。
tableName で	文字列	インシデントなどのレコードを書き込むテーブルの名前。
コーダー	コーダー	オプション。ServiceNowインスタンスとの間で送受信されるデータのエンコードまたはデコードに使用するコーダー。 可能な値： default: 既定のエンコーダーは、デバイスの Locale と TimeZone を使用して、yyy-MM-dd HH:mm:ss 形式を使用して日付を書式設定します。 custom(JSONEncoder, JSONDecoder): カスタムコーダーを使用して、JSON のデコード/エンコードをよりきめ細かく制御します。 この列挙体は、特別な日付形式、タイムゾーン、ロケールを使用する場合などに、独自の JSONEncoder と JSONDecoderを提供する場合にのみ使用してください。 let myEncoder = JSONEncoder() myEncoder.dateFormat = … let myDecoder = JSONDecoder() myDecoder.dateFormat = … let coder: Coder = .custom(myEncoder, myDecoder) デフォルト:.default
writeOptions	FieldWriteOptions	オプション。レコードに書き込まれるデータに適用する構成オプション。 デフォルト:nil
構成	FetchConfiguration	オプション。返されるレコード、ページネーションページサイズ制限、取得するフィールド、フィールドに含める内容を定義するフィルターを含む、取得したレコードに適用する構成。 デフォルト:nil - すべてのレコードが返されます。

表 : 54. 戻り値

タイプ

説明

AnyPublisher<Model、NowDataError>

成功:指定されたテーブルで更新されたデコード可能なモデル。 エラー:NowDataError accessToken(AccessTokenProviderError) AccessTokenProviderError:アクセストークンプロバイダーのエラーコードまたはメッセージ。 アクセストークン回収失敗 userSessionError(_ error: Error) アクセストークンにエラーがある場合にスローされます。 attachmentValidation 添付ファイルが検証に失敗した場合にスローされます。 badResponse (statusCode: HTTPStatusCode) HTTPStatusCode:インスタンスから受信したステータスコード。 要求が予期しない応答を返すとスローされます cannotDecodeModel(デコードエラー) DecodingError:デコードエラーが検出されました。 コード可能なモデルを JSON からデコードできない場合にスローされます。 cannotDecodeProperty(type: Any, from: String) type:文字列からデコードするためのラップされた型。 from:指定したタイプにデコードする文字列。 文字列でラップされた値を JSON からデコードできない場合にスローされます。 cannotEncodeModel(EncodingError) EncodingError:エンコードエラーが検出されました。 コード可能なモデルを JSON にエンコードできない場合にスローされます。 応答を解析できません インスタンスからの応答を想定される形式に解析できない場合にスローされます。 無効なURL URL を形成できない場合にスローされます。たとえば、文字列に URL で無効な文字が含まれている場合や、空の文字列である場合などです。 missingAttachmentMetadata 添付ファイルのメタデータヘッダーがない場合にスローされます。 missingServiceConfiguration 想定されるサービス構成がない場合にスローされます。 missingSysID 想定されるsys_idパラメーターがない場合にスローされます。 ネットワーク (NetworkServiceError) genericError(文字列) operationCanceled サービス無効 serverError(エラー) systemError(エラー) ネットワークサービスでエラーが発生するとスローされます。

次のコード例は、このメソッドを呼び出す方法を示しています。

struct User: SysIdentifiableModel {
  var sysId: String = ""
  var name: String
}

let user = User(sysId: "12345", name: "abel")
let coder: Coder = .default

tableService.update(user, in: "sys_user")
  .subscribe(on: DispatchQueue.global())
  .receive(on: DispatchQueue.main)
  .sink { [weak self] completion in
    if case let .failure(error) = completion {
      // Failed to update with NowDataError
      self?.publish(result: .failure(error))
    }
  } receiveValue: { [weak self] updatedModel in
    do {
      let data = try coder.jsonEncoder.encode(updatedModel)
      self?.publish(data: data)
    } catch {
      // Failed to update with NowDataError
      self?.publish(result: .failure(error))
    }
  }
  .store(in: &subscriptions)

NowTableService - updateRecord(sysId: SysID, in tableName: String, withfields: [FieldName: FieldValue], writeOptions: FieldWriteOptions? = nil, configuration: FieldReadConfiguration? = nil) 非同期がスローします

指定されたフィールドで指定されたレコードを更新します。

データをカスタム の Codable モデルにデコードするか、関数 NowTableService - paginator<Model: Decodable>(from tableName: String, path: String = Constants.resultPath, coder: Coder = .default, configuration: FetchConfiguration? = nil) を使用できます。 または、便利な関数 convertToRecords() を使用して、データを NowRecord オブジェクトに変換することもできます。次に、パブリッシャーを変換して NowRecord を発行する方法を示します。

let dataPublisher: AnyPublisher<Data, NowDataError> = ...
let recordsPublisher: AnyPublisher<[NowRecord], NowDataError> = myPublisher.convertToRecords()

注:

レコード内のすべてのフィールドは更新できない場合があります。たとえば、プリフィックスが sys_ のフィールドは、通常、自動的に生成されるシステムパラメーターであり、更新することはできません。指定されず、システムによって自動生成されないフィールドは、関連するデータタイプの null 値に設定されます。

表 : 55. パラメーター

名前	タイプ	説明
sysId	文字列	ServiceNowインスタンスから返されるレコードのSys_id。
フィールドあり	[FieldName: FieldValue]	レコードに含めるフィールドの名前と値のペア。
tableName で	文字列	インシデントなどのレコードを書き込むテーブルの名前。
writeOptions	FieldWriteOptions	オプション。レコードに書き込まれるデータに適用する構成オプション。 デフォルト:nil
構成	FetchConfiguration	オプション。返されるレコード、ページネーションページサイズ制限、取得するフィールド、フィールドに含める内容を定義するフィルターを含む、取得したレコードに適用する構成。 デフォルト:nil - すべてのレコードが返されます。

表 : 56. 返される内容

タイプ	説明
データ	メソッドが成功したときに返されます。更新されたレコードを含むデータオブジェクト。
NowDataError	メソッドが失敗したときにスローされます。 accessToken(AccessTokenProviderError) AccessTokenProviderError:アクセストークンプロバイダーのエラーコードまたはメッセージ。 アクセストークン回収失敗 userSessionError(_ error: Error) アクセストークンにエラーがある場合にスローされます。 attachmentValidation 添付ファイルが検証に失敗した場合にスローされます。 badResponse (statusCode: HTTPStatusCode) HTTPStatusCode:インスタンスから受信したステータスコード。 要求が予期しない応答を返すとスローされます cannotDecodeModel(デコードエラー) DecodingError:デコードエラーが検出されました。 コード可能なモデルを JSON からデコードできない場合にスローされます。 cannotDecodeProperty(type: Any, from: String) type:文字列からデコードするためのラップされた型。 from:指定したタイプにデコードする文字列。 文字列でラップされた値を JSON からデコードできない場合にスローされます。 cannotEncodeModel(EncodingError) EncodingError:エンコードエラーが検出されました。 コード可能なモデルを JSON にエンコードできない場合にスローされます。 応答を解析できません インスタンスからの応答を想定される形式に解析できない場合にスローされます。 無効なURL URL を形成できない場合にスローされます。たとえば、文字列に URL で無効な文字が含まれている場合や、空の文字列である場合などです。 missingAttachmentMetadata 添付ファイルのメタデータヘッダーがない場合にスローされます。 missingServiceConfiguration 想定されるサービス構成がない場合にスローされます。 missingSysID 想定されるsys_idパラメーターがない場合にスローされます。 ネットワーク (NetworkServiceError) genericError(文字列) operationCanceled サービス無効 serverError(エラー) systemError(エラー) ネットワークサービスでエラーが発生するとスローされます。

次のコード例は、このメソッドを呼び出す方法を示しています。

do { 
    let dataResult: Data = try await tableService.updateRecord(with: fields, in: tableName, writeOptions: writeOptions, configuration: configuration) 
    let recordResult: NowRecord = dataResult.convertToRecord() 
} catch { 
    print("Record update failed with NowDataError: \(error)") 
}

NowTableService - updateRecord(sysId: SysID, in tableName: String, with fields: [FieldName: FieldValue], writeOptions: FieldWriteOptions? = nil, configuration: FieldReadConfiguration? = nil, completion: @escaping (Result<Data, NowDataError>)

指定されたフィールドで指定されたレコードを更新し、レコードが保存された後に completion ハンドラーを実行します。

必要に応じて、返された結果をカスタムの Codable モデルにデコードするか、代わりに関数 NowTableService - paginator<Model: Decodable>(from tableName: String, path: String = Constants.resultPath, coder: Coder = .default, configuration: FetchConfiguration? = nil) を使用できます。 または、便利な関数 convertToRecords() を使用して、データを NowRecord オブジェクトに変換することもできます。次に、パブリッシャーを変換して NowRecord を発行する方法を示します。

let dataPublisher: AnyPublisher<Data, NowDataError> = ...
let recordsPublisher: AnyPublisher<[NowRecord], NowDataError> = myResult.convertToRecords()

注:

レコード内のすべてのフィールドは更新できない場合があります。たとえば、プリフィックスが sys_ のフィールドは、通常、自動的に生成されるシステムパラメーターであり、更新することはできません。指定されず、システムによって自動生成されないフィールドは、関連するデータタイプの null 値に設定されます。

表 : 57. パラメーター

名前	タイプ	説明
sysId	文字列	ServiceNowインスタンスから返されるレコードのSys_id。
フィールドあり	[FieldName: FieldValue]	レコードに含めるフィールドの名前と値のペア。
tableName で	文字列	インシデントなどのレコードを書き込むテーブルの名前。
writeOptions	FieldWriteOptions	オプション。レコードに書き込まれるデータに適用する構成オプション。 デフォルト:nil
構成	FetchConfiguration	オプション。返されるレコード、ページネーションページサイズ制限、取得するフィールド、フィールドに含める内容を定義するフィルターを含む、取得したレコードに適用する構成。 デフォルト:nil - すべてのレコードが返されます。
完了	@escaping (result<data, NowDataError>)	レコードが取得された後に実行する補完ハンドラー。 戻り値: 成功:データ:要求されたレコード エラー:NowDataError accessToken(AccessTokenProviderError) AccessTokenProviderError:アクセストークンプロバイダーのエラーコードまたはメッセージ。 アクセストークン回収失敗 userSessionError(_ error: Error) アクセストークンにエラーがある場合にスローされます。 attachmentValidation 添付ファイルが検証に失敗した場合にスローされます。 badResponse (statusCode: HTTPStatusCode) HTTPStatusCode:インスタンスから受信したステータスコード。 要求が予期しない応答を返すとスローされます cannotDecodeModel(デコードエラー) DecodingError:デコードエラーが検出されました。 コード可能なモデルを JSON からデコードできない場合にスローされます。 cannotDecodeProperty(type: Any, from: String) type:文字列からデコードするためのラップされた型。 from:指定したタイプにデコードする文字列。 文字列でラップされた値を JSON からデコードできない場合にスローされます。 cannotEncodeModel(EncodingError) EncodingError:エンコードエラーが検出されました。 コード可能なモデルを JSON にエンコードできない場合にスローされます。 応答を解析できません インスタンスからの応答を想定される形式に解析できない場合にスローされます。 無効なURL URL を形成できない場合にスローされます。たとえば、文字列に URL で無効な文字が含まれている場合や、空の文字列である場合などです。 missingAttachmentMetadata 添付ファイルのメタデータヘッダーがない場合にスローされます。 missingServiceConfiguration 想定されるサービス構成がない場合にスローされます。 missingSysID 想定されるsys_idパラメーターがない場合にスローされます。 ネットワーク (NetworkServiceError) genericError(文字列) operationCanceled サービス無効 serverError(エラー) systemError(エラー) ネットワークサービスでエラーが発生するとスローされます。

表 : 58. 返される内容

タイプ	説明
なし

次のコード例は、このメソッドを呼び出す方法を示しています。

tableService.updateRecord(sysId: sysId, in: tableName, with: fields, writeOptions: writeOptions, configuration: readConfiguration) { [weak self] result in
  switch result {
    case .success(let data):
      self?.publish(data: data)
    case .failure(let error):
       // Failed to update with NowDataError
  }
}

NowTableService - updateRecord(sysId: SysID, in tableName: String, withfields: [FieldName: FieldValue], writeOptions: FieldWriteOptions? = nil, configuration: FieldReadConfiguration? = nil)

指定されたフィールドで指定されたレコードを更新します。

注:

このメソッドは廃止されました。代わりに、メソッドの async/await 実装を使用する必要があります。

Publisher は、カスタムの Codable モデルにデコードできるデータを出力するか、 NowTableService - paginator<Model: Decodable>(from tableName: String, path: String = Constants.resultPath, coder: Coder = .default, configuration: FetchConfiguration? = nil) 関数を使用することもできます。 または、便利な関数 convertToRecords() を使用して、データを NowRecord オブジェクトに変換することもできます。次に、パブリッシャーを変換して NowRecord を発行する方法を示します。。

let dataPublisher: AnyPublisher<Data, NowDataError> = ...
let recordsPublisher: AnyPublisher<[NowRecord], NowDataError> = myPublisher.convertToRecords()

注:

レコード内のすべてのフィールドは更新できない場合があります。たとえば、プリフィックスが sys_ のフィールドは、通常、自動的に生成されるシステムパラメーターであり、更新することはできません。指定されず、システムによって自動生成されないフィールドは、関連するデータタイプの null 値に設定されます。

表 : 59. パラメーター

名前	タイプ	説明
sysId	文字列	ServiceNowインスタンスから返されるレコードのSys_id。
フィールドあり	[FieldName: FieldValue]	レコードに含めるフィールドの名前と値のペア。
tableName で	文字列	インシデントなどのレコードを書き込むテーブルの名前。
writeOptions	FieldWriteOptions	オプション。レコードに書き込まれるデータに適用する構成オプション。 デフォルト:nil
構成	FetchConfiguration	オプション。返されるレコード、ページネーションページサイズ制限、取得するフィールド、フィールドに含める内容を定義するフィルターを含む、取得したレコードに適用する構成。 デフォルト:nil - すべてのレコードが返されます。

表 : 60. 返される内容

タイプ

説明

AnyPublisher<Data、NowDataError>

成功:更新されたレコードを含むデータオブジェクト。 エラー:NowDataError accessToken(AccessTokenProviderError) AccessTokenProviderError:アクセストークンプロバイダーのエラーコードまたはメッセージ。 アクセストークン回収失敗 userSessionError(_ error: Error) アクセストークンにエラーがある場合にスローされます。 attachmentValidation 添付ファイルが検証に失敗した場合にスローされます。 badResponse (statusCode: HTTPStatusCode) HTTPStatusCode:インスタンスから受信したステータスコード。 要求が予期しない応答を返すとスローされます cannotDecodeModel(デコードエラー) DecodingError:デコードエラーが検出されました。 コード可能なモデルを JSON からデコードできない場合にスローされます。 cannotDecodeProperty(type: Any, from: String) type:文字列からデコードするためのラップされた型。 from:指定したタイプにデコードする文字列。 文字列でラップされた値を JSON からデコードできない場合にスローされます。 cannotEncodeModel(EncodingError) EncodingError:エンコードエラーが検出されました。 コード可能なモデルを JSON にエンコードできない場合にスローされます。 応答を解析できません インスタンスからの応答を想定される形式に解析できない場合にスローされます。 無効なURL URL を形成できない場合にスローされます。たとえば、文字列に URL で無効な文字が含まれている場合や、空の文字列である場合などです。 missingAttachmentMetadata 添付ファイルのメタデータヘッダーがない場合にスローされます。 missingServiceConfiguration 想定されるサービス構成がない場合にスローされます。 missingSysID 想定されるsys_idパラメーターがない場合にスローされます。 ネットワーク (NetworkServiceError) genericError(文字列) operationCanceled サービス無効 serverError(エラー) systemError(エラー) ネットワークサービスでエラーが発生するとスローされます。

この例では、指定したテーブルのレコードを指定したフィールドで更新する関数を作成する方法を示します。呼び出しの出力は ByteArray で、データを任意のモデルに変換できます。

tableService.updateRecord(sysId: sysId, in: tableName, with: fields, writeOptions: writeOptions, configuration: readConfiguration)
    .subscribe(on: DispatchQueue.global())
    .receive(on: DispatchQueue.main)
    .convertToRecord()
    .sink { completion in
        if case let .failure(error) = completion {
            print("Update failed with NowDataError: \(error)")
        }
    } receiveValue: { record in
        print("Record updated: \(record)")
    }
    .store(in: &subscriptions)