Interface NowTableService : Android

  • Rversion finale: Yokohama
  • Mis à jour 30 janv. 2025
  • 5 minutes de lecture
  • L’interface NowTableService fournit des fonctions qui vous permettent de créer, lire, supprimer et mettre à jour des enregistrements dans une table sur une ServiceNow instance.

    Tableau 1. Propriétés
    Nom Type Description
    configuration NowServiceConfiguration Configuration à associer au service.

    NowTableService : createRecord(tableName : String, fields : Map<String, String>, writeOptions : FieldWriteOptions ?, configuration : FieldReadConfiguration ?)

    Insère l’enregistrement spécifié dans la table spécifiée.

    Tableau 2. Paramètres
    Nom Type Description
    tableName Chaîne Nom de la table dans laquelle enregistrer l’enregistrement.
    champs map<chaîne, chaîne> Paires clé-valeur pour tous les champs à créer dans l’enregistrement.
    Remarque :
    Tous les champs d’un enregistrement peuvent ne pas être disponibles pour la mise à jour. Par exemple, les champs dont le préfixe est sys_ sont généralement des paramètres système qui sont générés automatiquement et ne peuvent pas être mis à jour. Les champs qui ne sont pas spécifiés et qui ne sont pas générés automatiquement par le système sont définis sur la valeur null du type de données associé.
    options d’écriture Options d’écriture de champ Facultatif. Options d’écriture à définir sur les champs, par exemple si la valeur doit être stockée comme valeurs d’affichage ou s’il faut supprimer la génération automatique de champs système.

    Par défaut : nul : aucune option sélectionnée

    configuration Configuration de lecture de champ Facultatif. Configuration qui spécifie les champs à renvoyer pour l’enregistrement créé et ce qu’il faut inclure dans les champs.
    Tableau 3. Renvoie
    Type Description
    Appel<ByteArray> Réussite : ByteArray contenant l’enregistrement créé. Vous pouvez convertir ces informations en n’importe quel modèle de données dont vous avez besoin.

    Échec : NowDataError

    fun createTableRecord( tableName: String, fields: KeyValues, includeFields: String, 
      readOptions: ReadOptions?, writeOptions: WriteOptions?){ 
     
      val readOptionsArray = readOptions?.asArray() ?: arrayOf() 
      val readConfig = FieldReadConfiguration(includeFields.split(","), *readOptionsArray) 
     
      var body:ByteArray? 
     
      val call = tableService.createRecord(tableName, fields.toMap(), 
        writeOptions?.asFieldWriteOptions(), 
        readConfig) 
      call.enqueue({ body = it.body },{ Log.d("Records", "failed to create record") }) 
    } 

    NowTableService : deleteRecord(sysId : chaîne, tableName : chaîne)

    Supprime l’enregistrement spécifié dans la table spécifiée.

    Tableau 4. Paramètres
    Nom Type Description
    sysId Chaîne Sys_id de l’enregistrement à supprimer.
    tableName Chaîne Nom de la table dans laquelle se trouve l’enregistrement spécifié, tel que l’incident ou l’actif.
    Tableau 5. Renvoie
    Type Description
    Appel<ByteArray> Réussite : rien n’est retourné.

    Échec : NowDataError

    fun deleteTableRecord( recordSysId: String, tableName: String, callType: CallTestType){ 
      val tableService = serviceProvider.tableService()
      var body:ByteArray? 
      val call = tableService.deleteRecord(recordSysId, tableName) 
      call.enqueue({ body = it.body },{ Log.d("Records", "failed to create record") }) 
    } 

    NowTableService : paginator(tableName : String, configuration : FetchConfiguration)

    Crée un paginateur qui permet l’itération de pages d’enregistrements dans une table.

    Vous pouvez utiliser ce paginateur pour parcourir les enregistrements renvoyés, effectuer des opérations de navigation telles que l’extraction de la première, de la dernière, de la page précédente ou de la page suivante, ou vérifier s’il existe une page suivante ou précédente.

    Tableau 6. Paramètres
    Nom Type Description
    tableName Chaîne Nom de la table pour laquelle créer le paginateur.
    configuration Configuration de récupération Configuration qui spécifie les filtres à utiliser, la limite de taille de page de pagination, les champs à récupérer et ce qu’il faut inclure dans les champs.
    Tableau 7. Renvoie
    Type Description
    Paginateur<ByteArray> Réussite : paginateur avec sortie ByteArray des enregistrements demandés. Vous pouvez utiliser les fonctions de l’objet Paginator pour naviguer dans les enregistrements renvoyés.

    Échec : NowDataError

    private fun initTablePaginator() { 
      paginator = service?.paginator(tableName, FetchConfiguration(null, 3)) 
        ?.observe(object: PaginatorCallBack<ByteArray> { 
          override fun onSuccess(response: Response<List<ByteArray>>) { 
          } 
          override fun onFailure(e: NowDataError) { 
            Log.e("NowDataError", "", e) 
          } 
        }) 
    }

    NowTableService : record(sysId : String, tableName : String, configuration : FieldReadConfiguration ?)

    Récupère l’enregistrement spécifié à partir de la table spécifiée.

    Tableau 8. Paramètres
    Nom Type Description
    sysId Chaîne Sys_id de l’enregistrement à récupérer.
    tableName Chaîne Nom de la table dans laquelle se trouve l’enregistrement spécifié, tel que l’incident ou l’actif.
    configuration Configuration de lecture de champ Facultatif. Configuration qui spécifie les champs à récupérer et ceux à inclure dans les champs.
    Tableau 9. Renvoie
    Type Description
    Appel<ByteArray> Réussite : ByteArray qui contient l’enregistrement récupéré. Vous pouvez convertir ces informations en n’importe quel modèle de données dont vous avez besoin.

    Échec : NowDataError

    fun fetchTableRecord( sysId: String, tableName: String, includeFields: String, 
      readOptions: ReadOptions?){ 
     
      val readOptionsArray = readOptions?.asArray() ?: arrayOf() 
      val readConfig = FieldReadConfiguration(includeFields.split(","), *readOptionsArray) 
     
      var body:ByteArray? 
     
      val call = tableService.record(sysId, tableName, readConfig) 
      call.enqueue({ body = it.body },{ Log.d("Record", "failed fetching record") }) 
    }

    NowTableService : records(tableName : String, configuration : FieldReadConfiguration ?)

    Récupère l’enregistrement des enregistrements SLL de la table spécifiée.

    Tableau 10. Paramètres
    Nom Type Description
    tableName Chaîne Nom de la table à partir de laquelle récupérer les enregistrements, tels que l’incident ou l’actif.
    configuration Configuration de lecture de champ Facultatif. Configuration qui spécifie les champs à récupérer et ceux à inclure dans les champs.
    Tableau 11. Renvoie
    Type Description
    Appel<ByteArray> Réussite : ByteArray qui contient les enregistrements récupérés. Vous pouvez convertir ces informations en n’importe quel modèle de données dont vous avez besoin.

    Échec : NowDataError

    fun fetchTableRecords( tableName: String, filterQuery: String, includeFields: String, 
      readOptions: ReadOptions?, limit: Int?){ 
     
      val readOptionsArray = readOptions?.asArray() ?: arrayOf() 
      val readConfig = FieldReadConfiguration(includeFields.split(","), *readOptionsArray) 
      val config = FetchConfiguration(Filter(filterQuery), limit, readConfig) 
     
      var body:ByteArray? 
     
      val call = tableService.records(tableName, config) 
      call.enqueue({ body = it.body },{ Log.d("Records", "failed fetching records") }) 
    } 

    NowTableService : updateRecord(sysId : String, tableName : String, fields : Map<String, String>, writeOptions : FieldWriteOptions ?, configuration : FieldReadConfiguration ?)

    Met à jour l’enregistrement spécifié dans la table spécifiée avec les champs spécifiés.

    Tableau 12. Paramètres
    Nom Type Description
    tableName Chaîne Nom de la table dans laquelle mettre à jour l’enregistrement.
    champs map<chaîne, chaîne> Paires clé-valeur pour tous les champs à mettre à jour dans l’enregistrement.
    Remarque :
    Tous les champs d’un enregistrement peuvent ne pas être disponibles pour la mise à jour. Par exemple, les champs dont le préfixe est sys_ sont généralement des paramètres système qui sont générés automatiquement et ne peuvent pas être mis à jour. Les champs qui ne sont pas spécifiés et qui ne sont pas générés automatiquement par le système sont définis sur la valeur null du type de données associé.
    options d’écriture Options d’écriture de champ Facultatif. Options d’écriture à définir sur les champs, par exemple si la valeur doit être stockée comme valeurs d’affichage ou s’il faut supprimer la génération automatique de champs système.

    Par défaut : nul : aucune option sélectionnée

    configuration Configuration de lecture de champ Facultatif. Configuration qui spécifie les champs à mettre à jour et ceux à inclure dans les champs.

    Valeur par défaut : nul

    Tableau 13. Renvoie
    Type Description
    Appel<ByteArray> Réussite : ByteArray qui contient l’enregistrement mis à jour. Vous pouvez convertir ces informations en n’importe quel modèle de données dont vous avez besoin.

    Échec : NowDataError

    fun updateTableRecord( sysId: String, tableName: String, fields: KeyValues, includeFields: String, 
       readOptions: ReadOptions?, writeOptions: WriteOptions?){ 
     
       val readOptionsArray = readOptions?.asArray() ?: arrayOf() 
       val readConfig = FieldReadConfiguration(includeFields.split(","), *readOptionsArray) 
     
       var body:ByteArray? 
     
       val call = tableService.updateRecord(recordSysId, tableName, fields.toMap(), 
         writeOptions?.asFieldWriteOptions(), 
         readConfig) 
       call.enqueue({ body = it.body },{ Log.d("Records", "failed to update record") }) 
    }