NowTableService クラス - iOS
NowTableService クラスは、既存のServiceNowテーブルのレコードに対して作成、読み取り、更新、および削除操作を実行できる関数を提供します。
| 名前 | タイプ | Description (説明) |
|---|---|---|
| 構成 | 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ハンドラーの結果モデルに返されます。
| 名前 | タイプ | Description (説明) |
|---|---|---|
| モデル | SysIdentifiableModel | テーブルに挿入するフィールドのモデル定義。 |
| tableName 内 | 文字列 | レコードを書き込むテーブルの名前 ( インシデントなど)。 |
| コーダー | コーダー | オプション。ServiceNow インスタンスとの間で送受信されるデータのエンコードまたはデコードに使用するコーダー。可能な値：
デフォルト:.default |
| 書き込みオプション | フィールド書き込みオプション | オプション。レコードに書き込まれるデータに適用する構成オプション。 デフォルト:nil |
| 構成 | FetchConfiguration | オプション。返されるレコード、ページネーションページのサイズ制限、取得するフィールド、フィールドに含めるものを定義するフィルターなど、取得したレコードに適用する構成。 デフォルト:nil - すべてのレコードが返されます。 |
| タイプ | Description (説明) |
|---|---|
| モデル | メソッドが成功したときに返されます。指定されたテーブルに挿入されたコード化可能モデル (sys_Idを含む)。このsys_idを使用して、今後のメソッド呼び出しでこのレコードを参照します。 |
| NowDataError | メソッドが失敗したときにスローされます。
|
次のコード例は、このメソッドを呼び出す方法を示しています。
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>))
指定された Codable モデルを指定されたテーブルに挿入し、 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ハンドラーの結果モデルに返されます。
| 名前 | タイプ | Description (説明) |
|---|---|---|
| モデル | SysIdentifiableModel | テーブルに挿入するフィールドのモデル定義。 |
| tableName 内 | 文字列 | レコードを書き込むテーブルの名前 ( インシデントなど)。 |
| コーダー | コーダー | オプション。ServiceNow インスタンスとの間で送受信されるデータのエンコードまたはデコードに使用するコーダー。可能な値：
デフォルト:.default |
| 書き込みオプション | フィールド書き込みオプション | オプション。レコードに書き込まれるデータに適用する構成オプション。 デフォルト:nil |
| 構成 | FetchConfiguration | オプション。返されるレコード、ページネーションページのサイズ制限、取得するフィールド、フィールドに含めるものを定義するフィルターなど、取得したレコードに適用する構成。 デフォルト:nil - すべてのレコードが返されます。 |
| 完了 | @escaping (Result<Model, NowDataError>) | 指定された復号可能モデルの作成後に実行する完了ハンドラー。 完了ハンドラーの戻り値:
|
| タイプ | 説明 |
|---|---|
| なし |
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 つのコード化可能モデルを挿入します。
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):
...
}
}receiveValueコールバックモデルで返されます。| 名前 | タイプ | Description (説明) |
|---|---|---|
| モデル | SysIdentifiableModel | テーブルに挿入する SysIdentifiableModel モデル。 |
| tableName 内 | 文字列 | レコードを書き込むテーブルの名前 ( インシデントなど)。 |
| path | 文字列 | オプション。ネストされた型のドット区切りパス。たとえば、 より 深い入れ子の場合は result または foo.bar.baz です。デフォルト: |
| コーダー | コーダー | オプション。ServiceNow インスタンスとの間で送受信されるデータのエンコードまたはデコードに使用するコーダー。可能な値：
デフォルト:.default |
| 書き込みオプション | フィールド書き込みオプション | オプション。レコードに書き込まれるデータに適用する構成オプション。 デフォルト:nil |
| 構成 | FetchConfiguration | オプション。返されるレコード、ページネーションページのサイズ制限、取得するフィールド、フィールドに含めるものを定義するフィルターなど、取得したレコードに適用する構成。 デフォルト:nil - すべてのレコードが返されます。 |
| タイプ | Description (説明) |
|---|---|
| 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) 非同期スロー
指定されたフィールドを含む指定されたテーブルにレコードを挿入します。
let dataPublisher: AnyPublisher<Data, NowDataError> = ...
let recordsPublisher: AnyPublisher<[NowRecord], NowDataError> = myPublisher.convertToRecords()sys_ のフィールドは、通常、自動的に生成され、更新できないシステムパラメーターです。指定されておらず、システムによって自動生成されていないフィールドは、関連するデータタイプの NULL 値に設定されます。| 名前 | タイプ | 説明 |
|---|---|---|
| フィールドあり | [FieldName:FieldValue] | レコードに含めるフィールドの名前と値のペア。 |
| tableName 内 | 文字列 | レコードを書き込むテーブルの名前 ( インシデントなど)。 |
| 書き込みオプション | フィールド書き込みオプション | オプション。レコードに書き込まれるデータに適用する構成オプション。 デフォルト:nil |
| 構成 | FetchConfiguration | オプション。返されるレコード、ページネーションページのサイズ制限、取得するフィールド、フィールドに含めるものを定義するフィルターなど、取得したレコードに適用する構成。 デフォルト:nil - すべてのレコードが返されます。 |
| タイプ | 説明 |
|---|---|
| Data (データ) | メソッドが成功したときに返されます。新規レコードを含むデータオブジェクト。 |
| NowDataError | メソッドが失敗したときにスローされます。
|
次のコード例は、このメソッドを呼び出す方法を示しています。
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 ハンドラーを実行します。
let dataPublisher: AnyPublisher<Data, NowDataError> = ...
let recordsPublisher: AnyPublisher<[NowRecord], NowDataError> = myResult.convertToRecords()sys_ のフィールドは、通常、自動的に生成され、更新できないシステムパラメーターです。指定されておらず、システムによって自動生成されていないフィールドは、関連するデータタイプの NULL 値に設定されます。| 名前 | タイプ | 説明 |
|---|---|---|
| フィールドあり | [FieldName:FieldValue] | レコードに含めるフィールドの名前と値のペア。 |
| tableName 内 | 文字列 | レコードを書き込むテーブルの名前 ( インシデントなど)。 |
| 書き込みオプション | フィールド書き込みオプション | オプション。レコードに書き込まれるデータに適用する構成オプション。 デフォルト:nil |
| 構成 | FieldReadConfiguration | オプション。返すフィールドとフィールドに含める内容を指定する構成オプション。 デフォルト:nil |
| 完了 | @escaping (結果<データ、NowDataError>) | レコードを取得した後に実行する完了ハンドラー。 戻り値:
|
| タイプ | 説明 |
|---|---|
| なし |
次のコード例は、この関数を呼び出す方法を示しています。
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)
指定されたフィールドを含む指定されたテーブルにレコードを挿入します。
let dataPublisher: AnyPublisher<Data, NowDataError> = ...
let recordsPublisher: AnyPublisher<[NowRecord], NowDataError> = myPublisher.convertToRecords()sys_ のフィールドは、通常、自動的に生成され、更新できないシステムパラメーターです。指定されておらず、システムによって自動生成されていないフィールドは、関連するデータタイプの NULL 値に設定されます。| 名前 | タイプ | 説明 |
|---|---|---|
| フィールドあり | [FieldName:FieldValue] | レコードに含めるフィールドの名前と値のペア。 |
| tableName 内 | 文字列 | レコードを書き込むテーブルの名前 ( インシデントなど)。 |
| 書き込みオプション | フィールド書き込みオプション | オプション。レコードに書き込まれるデータに適用する構成オプション。 デフォルト:nil |
| 構成 | FetchConfiguration | オプション。返されるレコード、ページネーションページのサイズ制限、取得するフィールド、フィールドに含めるものを定義するフィルターなど、取得したレコードに適用する構成。 デフォルト:nil - すべてのレコードが返されます。 |
| タイプ | Description (説明) |
|---|---|
| AnyPublisher<Data、NowDataError> | 成功:更新されたレコードを含むデータオブジェクト。 失敗:NowDataError
|
この例では、指定されたテーブルに指定されたフィールドを使用してレコードを挿入する関数を作成する方法を示します。呼び出しの出力は 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
指定されたコード化可能モデルを指定されたテーブルから削除します。
| 名前 | タイプ | 説明 |
|---|---|---|
| モデル | モデル | テーブルから削除する SysIdentifiableModel。削除するレコードのsys_idが含まれている必要があります。 |
| テーブル名から | 文字列 | incident などの情報の削除元のテーブルの名前。 |
| タイプ | 説明 |
|---|---|
| なし | メソッドが成功したときには何も返されません。 |
| NowDataError | メソッドが失敗したときにスローされます。
|
次のコード例は、このメソッドを呼び出す方法を示しています。
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>))
指定されたテーブルから指定された Codable モデルを削除し、適切な completion ハンドラーを実行します。
| 名前 | タイプ | Description (説明) |
|---|---|---|
| モデル | モデル | テーブルから削除する SysIdentifiableModel。削除するレコードのsys_idが含まれている必要があります。 |
| テーブル名から | 文字列 | incident などの情報の削除元のテーブルの名前。 |
| 完了 | @escaping (結果<無効、NowDataError>) | 指定されたコード化可能モデルを削除した後に実行する完了ハンドラー。 戻り値:
|
| タイプ | 説明 |
|---|---|
| なし |
次のコード例は、この関数を呼び出す方法を示しています。
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)
指定されたコード化可能モデルを指定されたテーブルから削除します。
| 名前 | タイプ | 説明 |
|---|---|---|
| モデル | モデル | テーブルから削除する SysIdentifiableModel。削除するレコードのsys_idが含まれている必要があります。 |
| テーブル名から | 文字列 | incident などの情報の削除元のテーブルの名前。 |
| タイプ | Description (説明) |
|---|---|
| AnyPublisher<Void、NowDataError> | 成功:何も返されませんでした 失敗:NowDataError
|
次のコード例は、この関数を呼び出す方法を示しています。
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) async throws
指定されたテーブルから指定されたレコードを削除します。
| 名前 | タイプ | 説明 |
|---|---|---|
| sysId | 文字列 | 削除するレコードの sys_id。 |
| テーブル名から | 文字列 | incident などの情報の削除元のテーブルの名前。 |
| タイプ | 説明 |
|---|---|
| なし | メソッドが成功したときには何も返されません。 |
| NowDataError | メソッドが失敗したときにスローされます。
|
次のコード例は、このメソッドを呼び出す方法を示しています。
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 オブジェクトを実行します。
| 名前 | タイプ | Description (説明) |
|---|---|---|
| sysId | 文字列 | 削除するレコードの sys_id。 |
| テーブル名から | 文字列 | incident などの情報の削除元のテーブルの名前。 |
| 完了 | @escaping (結果<無効、NowDataError>) | 成功:何も返されません。 失敗:NowDataError
|
| タイプ | 説明 |
|---|---|
| なし |
次のコード例は、この関数を呼び出す方法を示しています。
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)
指定されたテーブルから指定されたレコードを削除します。
| 名前 | タイプ | 説明 |
|---|---|---|
| sysId | 文字列 | 削除するレコードの sys_id。 |
| テーブル名から | 文字列 | incident などの情報の削除元のテーブルの名前。 |
| タイプ | Description (説明) |
|---|---|
| AnyPublisher<Void、NowDataError> | 成功:何も返されませんでした 失敗:NowDataError
|
この例では、指定したテーブルのレコードを削除する関数を作成する方法を示します。
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: NowCoreServiceProviding? = nil)
NowTableService オブジェクトを作成します。
| 名前 | タイプ | Description (説明) |
|---|---|---|
| 構成 | NowServiceConfiguration | サービスの作成時に使用する設定パラメーター。 |
| coreServiceProvider | NowCoreServiceOffering | オプション。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>(with sysId: SysID? = nil, from tableName: String, path: String = Constants.resultPath, coder: coder = .default, configuration: FetchConfiguration? = nil) 非同期スロー
指定されたテーブルから復号化可能なモデルを取得できるようにします。
{
"result": [
{ "name": "Ash Williams" },
{ "name": "Lionel Cosgrove" },
{ "name": "Laurie Strode" }
]
}| 名前 | タイプ | Description (説明) |
|---|---|---|
| sysId あり | SysID | オプション。返されるレコードの sys_id。特定のレコードを取得する場合は、sys_idを入力します。 デフォルト:nil |
| テーブル名から | 文字列 | レコードの取得元となるテーブルの名前 ( incident など)。 |
| path | 文字列 | ネストされた型のドット区切りパス。たとえば、 より 深い入れ子の場合は result または foo.bar.baz です。デフォルト: |
| コーダー | コーダー | オプション。ServiceNow インスタンスとの間で送受信されるデータのエンコードまたはデコードに使用するコーダー。可能な値：
デフォルト:.default |
| 構成 | FetchConfiguration | オプション。返されるレコード、ページネーションページのサイズ制限、取得するフィールド、フィールドに含めるものを定義するフィルターなど、取得したレコードに適用する構成。 デフォルト:nil - すべてのレコードが返されます。 |
| タイプ | Description (説明) |
|---|---|
| モデル | メソッドが成功したときに返されます。復号化可能なモデル。 |
| NowDataError | メソッドが失敗したときにスローされます。
|
次のコード例は、このメソッドを呼び出す方法を示しています。
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>))
指定されたテーブルから復号化可能なモデルを取得します。
{
"result": [
{ "name": "Ash Williams" },
{ "name": "Lionel Cosgrove" },
{ "name": "Laurie Strode" }
]
}この関数を使用して、入れ子になった出力の代わりに復号化可能なモデルを取得します。
| 名前 | タイプ | 説明 |
|---|---|---|
| type | Model.Type | デコードする値のタイプ。 |
| sysId あり | 文字列 | オプション。返されるレコードの sys_id。 デフォルト: configuration 設定に従って返されるすべてのレコード。 |
| テーブル名から | 文字列 | レコードの取得元となるテーブルの名前 ( incident など)。 |
| path | 文字列 | オプション。ネストされた型のドット区切りパス。たとえば、 より 深い入れ子の場合は result または foo.bar.baz です。デフォルト: |
| コーダー | コーダー | オプション。ServiceNow インスタンスとの間で送受信されるデータのエンコードまたはデコードに使用するコーダー。デフォルト: |
| 構成 | FetchConfiguration | オプション。返されるレコード、ページネーションページのサイズ制限、取得するフィールド、フィールドに含めるものを定義するフィルターなど、取得したレコードに適用する構成。 デフォルト:nil - すべてのレコードが返されます。 |
| 完了 | @escaping (Result<Model, NowDataError>) | 指定された復号可能モデルを取得した後に実行する完了ハンドラー。 完了ハンドラーの戻り値:
|
| タイプ | 説明 |
|---|---|
| なし |
デコードされた 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):
...
}
}単一の復号化可能モデルをsys_idでフェッチするには、[User].self ではなく User.self などの単一のモデルタイプを使用します。
service.model(User.self, with: "5137153cc611227c000bbd1bd8cd2005", from: "sys_user", path: "result") { resultin ... }NowTableService - model<Model: Decodable>(with sysId: SysID? = nil, from tableName: String, path: String = Constants.resultPath, coder: coder = .default, configuration: FetchConfiguration? = nil)
指定されたテーブルから復号化可能なモデルを取得できるパブリッシャーを作成します。
{
"result": [
{ "name": "Ash Williams" },
{ "name": "Lionel Cosgrove" },
{ "name": "Laurie Strode" }
]
}| 名前 | タイプ | Description (説明) |
|---|---|---|
| sysId あり | SysID | オプション。返されるレコードの sys_id。特定のレコードを取得する場合は、sys_idを入力します。 デフォルト:nil |
| テーブル名から | 文字列 | レコードの取得元となるテーブルの名前 ( incident など)。 |
| path | 文字列 | ネストされた型のドット区切りパス。たとえば、 より 深い入れ子の場合は result または foo.bar.baz です。デフォルト: |
| コーダー | コーダー | オプション。ServiceNow インスタンスとの間で送受信されるデータのエンコードまたはデコードに使用するコーダー。可能な値：
デフォルト:.default |
| 構成 | FetchConfiguration | オプション。返されるレコード、ページネーションページのサイズ制限、取得するフィールド、フィールドに含めるものを定義するフィルターなど、取得したレコードに適用する構成。 デフォルト:nil - すべてのレコードが返されます。 |
| タイプ | Description (説明) |
|---|---|
| AnyPublisher<Model、NowDataError> | 成功:パブリッシャーがデコード可能なモデルを返します。 失敗:NowDataError
|
[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")
単一の復号可能モデルを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)
レコードのページを反復処理できるページネーターを作成します。
let dataPublisher: AnyPublisher<Data, NowDataError> = ...
let recordsPublisher: AnyPublisher<[NowRecord], NowDataError> = myPublisher.convertToRecords()| 名前 | タイプ | 説明 |
|---|---|---|
| tableName | 文字列 | レコードの取得元となるテーブルの名前 ( incident など)。 |
| 構成 | FetchConfiguration | オプション。返されるレコード、ページネーションページのサイズ制限、取得するフィールド、フィールドに含めるものを定義するフィルターなど、取得したレコードに適用する構成。 デフォルト:nil - すべてのレコードが返されます。 |
| タイプ | Description (説明) |
|---|---|
| paginator<data> | 成功:指定されたレコードを含むページネーターオブジェクト。 失敗:NowDataError
|
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)
ネストを処理するデコードされたモデルのページの反復を可能にするページネータを作成します。
{
"result": [
{ "name": "Ash Williams" },
{ "name": "Lionel Cosgrove" },
{ "name": "Laurie Strode" }
]
}struct User: Codable {
varname: String
}
let service: NowTableService = ...
let paginator: Paginator<[User]> = service.paginator(from: "sys_user", path: "result")paginator.publisher
.subscribe(on: DispatchQueue.global())
.receive(on: DispatchQueue.main)
.sink { … }
.store(in: &subscriptions)| 名前 | タイプ | 説明 |
|---|---|---|
| テーブル名から | 文字列 | レコードの取得元となるテーブルの名前 ( incident など)。 |
| path | 文字列 | ネストされた型のドット区切りパス。たとえば、より深いネストの場合は result や result.user.photos などです。カスタムパスを指定すると、ネストされたデータをフェッチまたは反復処理できます。デフォルト: |
| コーダー | コーダー | オプション。ServiceNow インスタンスとの間で送受信されるデータのエンコードまたはデコードに使用するコーダー。可能な値：
デフォルト:.default |
| 構成 | FetchConfiguration | オプション。返されるレコード、ページネーションページのサイズ制限、取得するフィールド、フィールドに含めるものを定義するフィルターなど、取得したレコードに適用する構成。 デフォルト:nil - すべてのレコードが返されます。 |
| タイプ | Description (説明) |
|---|---|
| paginator<data> | 成功:ページングされた デコナブル モデルを含むページネータオブジェクト。失敗:NowDataError
|
この例では、デコードされた User モデルを提供する 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")NowTableService - record(with sysId: SysID, from tableName: String, configuration: FieldReadConfiguration? = nil) async throws
ServiceNowインスタンスの指定されたテーブルから指定されたレコードを取得します。
let dataPublisher: AnyPublisher<Data, NowDataError> = ...
let recordsPublisher: AnyPublisher<[NowRecord], NowDataError> = myPublisher.convertToRecords()| 名前 | タイプ | 説明 |
|---|---|---|
| sysId | 文字列 | ServiceNowインスタンスから返されるレコードのSys_id。 |
| テーブル名から | 文字列 | レコードの取得元となるテーブルの名前 ( incident など)。 |
| 構成 | FetchConfiguration | オプション。返されるレコード、ページネーションページのサイズ制限、取得するフィールド、フィールドに含めるものを定義するフィルターなど、取得したレコードに適用する構成。 デフォルト:nil - すべてのレコードが返されます。 |
| タイプ | 説明 |
|---|---|
| Data (データ) | メソッドが成功したときに返されます。指定されたレコードを含むデータオブジェクト。 |
| NowDataError | メソッドが失敗したときにスローされます。
|
次のコード例は、このメソッドを呼び出す方法を示しています。
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>)
指定されたテーブルから指定されたレコードを取得し、レコードが取得された後に完了ハンドラーを実行します。
let dataPublisher: AnyPublisher<Data, NowDataError> = ...
let recordsPublisher: AnyPublisher<[NowRecord], NowDataError> = myResult.convertToRecords()| 名前 | タイプ | 説明 |
|---|---|---|
| sysId | 文字列 | ServiceNowインスタンスから返されるレコードのSys_id。 |
| テーブル名から | 文字列 | レコードの取得元となるテーブルの名前 ( incident など)。 |
| 構成 | FetchConfiguration | オプション。返されるレコード、ページネーションページのサイズ制限、取得するフィールド、フィールドに含めるものを定義するフィルターなど、取得したレコードに適用する構成。 デフォルト:nil - すべてのレコードが返されます。 |
| 完了 | @escaping (結果<データ、NowDataError>) | レコードを取得した後に実行する完了ハンドラー。 戻り値:
|
| タイプ | 説明 |
|---|---|
| なし |
次のコード例は、このメソッドを呼び出す方法を示しています。
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(with sysId: SysID, from tableName: String, configuration: FieldReadConfiguration? = nil)
ServiceNowインスタンスの指定されたテーブルから指定されたレコードを取得するパブリッシャーを作成します。
let dataPublisher: AnyPublisher<Data, NowDataError> = ...
let recordsPublisher: AnyPublisher<[NowRecord], NowDataError> = myPublisher.convertToRecords()| 名前 | タイプ | 説明 |
|---|---|---|
| sysId | 文字列 | ServiceNowインスタンスから返されるレコードのSys_id。 |
| テーブル名から | 文字列 | レコードの取得元となるテーブルの名前 ( incident など)。 |
| 構成 | FetchConfiguration | オプション。返されるレコード、ページネーションページのサイズ制限、取得するフィールド、フィールドに含めるものを定義するフィルターなど、取得したレコードに適用する構成。 デフォルト:nil - すべてのレコードが返されます。 |
| タイプ | Description (説明) |
|---|---|
| AnyPublisher<Data、NowDataError> | 成功:指定されたレコードを含むデータオブジェクト。 失敗:NowDataError
|
この例では、指定されたテーブルから指定されたフィールドを使用して、指定されたレコードを取得する関数を作成する方法を示します。呼び出しの出力は 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
指定されたテーブルからレコードを取得します。
let dataPublisher: AnyPublisher<Data, NowDataError> = ...
let recordsPublisher: AnyPublisher<[NowRecord], NowDataError> = myPublisher.convertToRecords()| 名前 | タイプ | 説明 |
|---|---|---|
| テーブル名から | 文字列 | レコードの取得元となるテーブルの名前 ( incident など)。 |
| 構成 | FetchConfiguration | オプション。返されるレコード、ページネーションページのサイズ制限、取得するフィールド、フィールドに含めるものを定義するフィルターなど、取得したレコードに適用する構成。 デフォルト:nil - すべてのレコードが返されます。 |
| タイプ | 説明 |
|---|---|
| Data (データ) | メソッドが成功したときに返されます。指定されたレコードを含むデータオブジェクト。 |
| NowDataError | メソッドが失敗したときにスローされます。
|
次のコード例は、このメソッドを呼び出す方法を示しています。
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 ハンドラーを実行します。
let dataPublisher: AnyPublisher<Data, NowDataError> = ...
let recordsPublisher: AnyPublisher<[NowRecord], NowDataError> = myResult.convertToRecords()| 名前 | タイプ | 説明 |
|---|---|---|
| tableName 内 | 文字列 | レコードを書き込むテーブルの名前 ( インシデントなど)。 |
| 構成 | FetchConfiguration | オプション。返されるレコード、ページネーションページのサイズ制限、取得するフィールド、フィールドに含めるものを定義するフィルターなど、取得したレコードに適用する構成。 デフォルト:nil - すべてのレコードが返されます。 |
| 完了 | @escaping (結果<データ、NowDataError>) | レコードを取得した後に実行する完了ハンドラー。 戻り値:
|
| タイプ | 説明 |
|---|---|
| なし |
次のコード例は、このメソッドを呼び出す方法を示しています。
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)
指定したテーブルからレコードを取得できるパブリッシャーを作成します。
let dataPublisher: AnyPublisher<Data, NowDataError> = ...
let recordsPublisher: AnyPublisher<[NowRecord], NowDataError> = myPublisher.convertToRecords()| 名前 | タイプ | 説明 |
|---|---|---|
| テーブル名から | 文字列 | レコードの取得元となるテーブルの名前 ( incident など)。 |
| 構成 | FetchConfiguration | オプション。返されるレコード、ページネーションページのサイズ制限、取得するフィールド、フィールドに含めるものを定義するフィルターなど、取得したレコードに適用する構成。 デフォルト:nil - すべてのレコードが返されます。 |
| タイプ | Description (説明) |
|---|---|
| AnyPublisher<Data、NowDataError> | 成功:指定されたレコードを含むデータオブジェクト。 失敗:NowDataError
|
この例では、指定したテーブルから複数のレコードをフェッチする関数を作成する方法を示します。これは、将来のある時点で実行されるように要求をスケジュールし、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
指定されたテーブル内の指定されたコード化可能モデルを更新します。
| 名前 | タイプ | Description (説明) |
|---|---|---|
| モデル | モデル | テーブルで更新する SysIdentifiableModel モデル。 |
| tableName 内 | 文字列 | レコードを書き込むテーブルの名前 ( インシデントなど)。 |
| コーダー | コーダー | オプション。ServiceNow インスタンスとの間で送受信されるデータのエンコードまたはデコードに使用するコーダー。可能な値：
デフォルト:.default |
| 書き込みオプション | フィールド書き込みオプション | オプション。レコードに書き込まれるデータに適用する構成オプション。 デフォルト:nil |
| 構成 | FetchConfiguration | オプション。返されるレコード、ページネーションページのサイズ制限、取得するフィールド、フィールドに含めるものを定義するフィルターなど、取得したレコードに適用する構成。 デフォルト:nil - すべてのレコードが返されます。 |
| タイプ | Description (説明) |
|---|---|
| モデル | メソッドが成功したときに返されます。指定されたテーブルで更新された復号化可能なモデル。 |
| NowDataError | メソッドが失敗したときにスローされます。
|
次のコード例は、このメソッドを呼び出す方法を示しています。
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>))
指定されたテーブル内の指定された Codable モデルを更新し、 completion ハンドラーを実行します。
| 名前 | タイプ | Description (説明) |
|---|---|---|
| モデル | モデル | テーブルで更新する SysIdentifiableModel モデル。 |
| tableName 内 | 文字列 | レコードを書き込むテーブルの名前 ( インシデントなど)。 |
| コーダー | コーダー | オプション。ServiceNow インスタンスとの間で送受信されるデータのエンコードまたはデコードに使用するコーダー。可能な値：
デフォルト:.default |
| 書き込みオプション | フィールド書き込みオプション | オプション。レコードに書き込まれるデータに適用する構成オプション。 デフォルト:nil |
| 構成 | FetchConfiguration | オプション。返されるレコード、ページネーションページのサイズ制限、取得するフィールド、フィールドに含めるものを定義するフィルターなど、取得したレコードに適用する構成。 デフォルト:nil - すべてのレコードが返されます。 |
| 完了 | @escaping (Result<Model, NowDataError>) | 指定されたコード化可能モデルを更新した後に実行する完了ハンドラー。 戻り値:
|
| タイプ | 説明 |
|---|---|
| なし |
次のコード例は、このメソッドを呼び出す方法を示しています。
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)
指定されたテーブルの指定されたコード可能モデルを更新します。
| 名前 | タイプ | Description (説明) |
|---|---|---|
| モデル | モデル | テーブルで更新する SysIdentifiableModel モデル。 |
| tableName 内 | 文字列 | レコードを書き込むテーブルの名前 ( インシデントなど)。 |
| コーダー | コーダー | オプション。ServiceNow インスタンスとの間で送受信されるデータのエンコードまたはデコードに使用するコーダー。可能な値：
デフォルト:.default |
| 書き込みオプション | フィールド書き込みオプション | オプション。レコードに書き込まれるデータに適用する構成オプション。 デフォルト:nil |
| 構成 | FetchConfiguration | オプション。返されるレコード、ページネーションページのサイズ制限、取得するフィールド、フィールドに含めるものを定義するフィルターなど、取得したレコードに適用する構成。 デフォルト:nil - すべてのレコードが返されます。 |
| タイプ | Description (説明) |
|---|---|
| AnyPublisher<Model、NowDataError> | 成功:指定されたテーブルで更新されたデコード可能なモデル。 失敗:NowDataError
|
次のコード例は、このメソッドを呼び出す方法を示しています。
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) async throws
指定されたレコードを指定されたフィールドで更新します。
let dataPublisher: AnyPublisher<Data, NowDataError> = ...
let recordsPublisher: AnyPublisher<[NowRecord], NowDataError> = myPublisher.convertToRecords()sys_ のフィールドは、通常、自動的に生成され、更新できないシステムパラメーターです。指定されておらず、システムによって自動生成されていないフィールドは、関連するデータタイプの NULL 値に設定されます。| 名前 | タイプ | 説明 |
|---|---|---|
| sysId | 文字列 | ServiceNowインスタンスから返されるレコードのSys_id。 |
| フィールドあり | [FieldName:FieldValue] | レコードに含めるフィールドの名前と値のペア。 |
| tableName 内 | 文字列 | レコードを書き込むテーブルの名前 ( インシデントなど)。 |
| 書き込みオプション | フィールド書き込みオプション | オプション。レコードに書き込まれるデータに適用する構成オプション。 デフォルト:nil |
| 構成 | FetchConfiguration | オプション。返されるレコード、ページネーションページのサイズ制限、取得するフィールド、フィールドに含めるものを定義するフィルターなど、取得したレコードに適用する構成。 デフォルト:nil - すべてのレコードが返されます。 |
| タイプ | 説明 |
|---|---|
| Data (データ) | メソッドが成功したときに返されます。更新されたレコードを含むデータオブジェクト。 |
| NowDataError | メソッドが失敗したときにスローされます。
|
次のコード例は、このメソッドを呼び出す方法を示しています。
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 ハンドラーを実行します。
let dataPublisher: AnyPublisher<Data, NowDataError> = ...
let recordsPublisher: AnyPublisher<[NowRecord], NowDataError> = myResult.convertToRecords()sys_ のフィールドは、通常、自動的に生成され、更新できないシステムパラメーターです。指定されておらず、システムによって自動生成されていないフィールドは、関連するデータタイプの NULL 値に設定されます。| 名前 | タイプ | 説明 |
|---|---|---|
| sysId | 文字列 | ServiceNowインスタンスから返されるレコードのSys_id。 |
| フィールドあり | [FieldName:FieldValue] | レコードに含めるフィールドの名前と値のペア。 |
| tableName 内 | 文字列 | レコードを書き込むテーブルの名前 ( インシデントなど)。 |
| 書き込みオプション | フィールド書き込みオプション | オプション。レコードに書き込まれるデータに適用する構成オプション。 デフォルト:nil |
| 構成 | FetchConfiguration | オプション。返されるレコード、ページネーションページのサイズ制限、取得するフィールド、フィールドに含めるものを定義するフィルターなど、取得したレコードに適用する構成。 デフォルト:nil - すべてのレコードが返されます。 |
| 完了 | @escaping (結果<データ、NowDataError>) | レコードを取得した後に実行する完了ハンドラー。 戻り値:
|
| タイプ | 説明 |
|---|---|
| なし |
次のコード例は、このメソッドを呼び出す方法を示しています。
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)
指定されたレコードを指定されたフィールドで更新します。
let dataPublisher: AnyPublisher<Data, NowDataError> = ...
let recordsPublisher: AnyPublisher<[NowRecord], NowDataError> = myPublisher.convertToRecords()sys_ のフィールドは、通常、自動的に生成され、更新できないシステムパラメーターです。指定されておらず、システムによって自動生成されていないフィールドは、関連するデータタイプの NULL 値に設定されます。| 名前 | タイプ | 説明 |
|---|---|---|
| sysId | 文字列 | ServiceNowインスタンスから返されるレコードのSys_id。 |
| フィールドあり | [FieldName:FieldValue] | レコードに含めるフィールドの名前と値のペア。 |
| tableName 内 | 文字列 | レコードを書き込むテーブルの名前 ( インシデントなど)。 |
| 書き込みオプション | フィールド書き込みオプション | オプション。レコードに書き込まれるデータに適用する構成オプション。 デフォルト:nil |
| 構成 | FetchConfiguration | オプション。返されるレコード、ページネーションページのサイズ制限、取得するフィールド、フィールドに含めるものを定義するフィルターなど、取得したレコードに適用する構成。 デフォルト:nil - すべてのレコードが返されます。 |
| タイプ | Description (説明) |
|---|---|
| AnyPublisher<Data、NowDataError> | 成功:更新されたレコードを含むデータオブジェクト。 失敗:NowDataError
|
この例では、指定したテーブルのレコードを指定したフィールドで更新する関数を作成する方法を示します。呼び出しの出力は 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)