---
sourceDocument: Référence de l’API Xanadu
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/fr-FR/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - fr-FR

ft:publication_title :

    - Référence de l’API Xanadu

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# Interface NowAttachmentService : Android

# Interface NowAttachmentService : Android {#ariaid-title1}

* Rversion finale: Xanadu
* 
* Mis à jour 1 août 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 3 minutes de lecture

L'interface NowAttachmentService fournit des fonctions qui permettent la manipulation des pièces jointes de fichier et de leurs métadonnées associées.
{#NowAttachServiceAndroidInterface__table_vx2_klw_5pb__entry__3}

| Nom | Type | Description |
|-|-|-|
| configuration | [Configuration Now ServiceConfiguration](https://servicenow-prod.fluidtopics.net/cw95tRreqlkfNCknivurbQ "La classe NowServiceConfiguration vous permet de configurer l’URL d’instance et le nom du ServiceNow package d’un service de fonctionnalités.") | Configuration à associer au service. |
[Tableau 1. Propriétés]

{#NowAttachServiceAndroidInterface__table_vx2_klw_5pb}

## NowAttachmentService : attachment(sysId : String, validateAttachment : Boolean = true) {#ariaid-title2}

Récupère la pièce jointe avec le sys_id spécifié et valide éventuellement la pièce jointe en comparant le hachage calculé de la pièce jointe au hachage attendu.
{#NAttServ-attachment_S_B__table_old_sp5_4pb__entry__3}

| Nom | Type | Description |
|-|-|-|
| sysId | Chaîne | Sys_id de la pièce jointe à récupérer. Il s'agit du sys_id de la pièce jointe sur votre ServiceNow instance. |
| validateAttachment | Booléen | Marqueur indiquant s'il faut valider la pièce jointe. Valeurs valides : * vrai : validez la pièce jointe. * faux : ne pas valider la pièce jointe. {#NAttServ-attachment_S_B__ul_ftq_1q5_4pb} Valeur par défaut : true |
[Tableau 2. Paramètres]

{#NAttServ-attachment_S_B__table_old_sp5_4pb} {#NAttServ-attachment_S_B__table_pld_sp5_4pb__entry__2}

| Type | Description |
|-|-|
| [Appeler](https://servicenow-prod.fluidtopics.net/Ftyw7Yt2YUqnJyFyCGm5lg#CallAndroidInterface "L’interface d’appel représente une demande préparée pour traitement.")\<[NowAttachment](https://servicenow-prod.fluidtopics.net/5ZJgOqTsTYopD2mM_yAeBw#NowAttachmentAndroidAPI "La classe NowAttachment fournit un objet qui contient une pièce jointe et les métadonnées qui lui sont associées.")\> | Objet NowAttachment qui contient la pièce jointe demandée. |
[Tableau 3. Renvoie]

{#NAttServ-attachment_S_B__table_pld_sp5_4pb}  
<br />

    fun getAttachment(sysId: String, isValidateAttachment: Boolean) { 
      val call = attachmentService.attachment(sysId, isValidateAttachment) 
      call.enqueue( 
        { response -> 
          val attachment: NowAttachment? = response.body 
        }, 
          { nowDataError -> handleError(nowDataError) } 
      ) 
    }

## NowAttachmentService : attachmentMetadata(sysId : chaîne) {#ariaid-title3}

Récupère les métadonnées de la pièce jointe associée au sys_id spécifié.
{#NAttServ-attachmentMetadata_S__table_bqq_1r5_4pb__entry__3}

| Nom | Type | Description |
|-|-|-|
| sysId | Chaîne | Sys_id de la pièce jointe dont vous souhaitez récupérer les métadonnées. |
[Tableau 4. Paramètres]

{#NAttServ-attachmentMetadata_S__table_bqq_1r5_4pb} {#NAttServ-attachmentMetadata_S__table_cqq_1r5_4pb__entry__2}

| Type | Description |
|-|-|
| [Appeler](https://servicenow-prod.fluidtopics.net/Ftyw7Yt2YUqnJyFyCGm5lg#CallAndroidInterface "L’interface d’appel représente une demande préparée pour traitement.")\<[NowAttachmentMetadata](https://servicenow-prod.fluidtopics.net/sFPXIItEFniLH7_Bk_vHmQ#NowAttachmentMetadataAndroidAPI "La classe NowAttachmentMetadata fournit des fonctions qui vous permettent d’encoder et de gérer les métadonnées de pièce jointe.")\> | Objet contenant les métadonnées de la pièce jointe spécifiée. |
[Tableau 5. Renvoie]

{#NAttServ-attachmentMetadata_S__table_cqq_1r5_4pb}  

    fun fetchMetadata(sysId: String) { 
      val call = attachmentService.attachmentMetadata(sysId) 
      call.enqueue(
        { response -> 
          val metadata: NowAttachmentMetadata? = response.body 
        },
        { nowDataError -> handleError(nowDataError) } 
      )
    }

## NowAttachmentService : attachmentMetadata(filter : Filter ? = null, limit : Int ? = null) {#ariaid-title4}

Récupère les métadonnées de toutes les pièces jointes qui répondent aux critères spécifiés.
{#NAttServ-attachmentMetadata_S_I___table_ujt_zc1_ppb__entry__3}

| Nom | Type | Description |
|-|-|-|
| filtre | [Filtrer](https://servicenow-prod.fluidtopics.net/Lbi2EuldoQUadQ4d8m74sw#FilterAndroidAPI "La classe Filter permet de configurer des filtres qui définissent les données à renvoyer dans les résultats renvoyés d’une requête de point de terminaison REST.") | Facultatif. Chaîne de requête à utiliser pour filtrer les pièces jointes dont les métadonnées doivent être renvoyées. Par défaut : null : renvoie les métadonnées pour toutes les pièces jointes disponibles. Prend en considération le limit paramètre. |
| limite | Entier | Facultatif. Nombre maximal de métadonnées du fichier de pièce jointe à renvoyer. Par défaut : null : renvoie toutes les métadonnées qui répondent aux spécifications du filter paramètre. |
[Tableau 6. Paramètres]

{#NAttServ-attachmentMetadata_S_I___table_ujt_zc1_ppb} {#NAttServ-attachmentMetadata_S_I___table_vjt_zc1_ppb__entry__2}

| Type | Description |
|-|-|
| [Call](https://servicenow-prod.fluidtopics.net/Ftyw7Yt2YUqnJyFyCGm5lg#CallAndroidInterface "L’interface d’appel représente une demande préparée pour traitement.")\<[List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/)\<[NowAttachmentMetadata](https://servicenow-prod.fluidtopics.net/sFPXIItEFniLH7_Bk_vHmQ#NowAttachmentMetadataAndroidAPI "La classe NowAttachmentMetadata fournit des fonctions qui vous permettent d’encoder et de gérer les métadonnées de pièce jointe.")\>\> | Liste des objets contenant les métadonnées des pièces jointes correspondantes. |
[Tableau 7. Renvoie]

{#NAttServ-attachmentMetadata_S_I___table_vjt_zc1_ppb}  

    fun fetchMultipleMetadata(filterQuery: String, limit: Int) { 
      val call = attachmentService.attachmentMetadata(Filter(filterQuery), limit) 
      call.enqueue( 
        { response -> 
          val metadataList: List<NowAttachmentMetadata>? = response.body 
        },
        { nowDataError -> handleError(nowDataError) } 
      )
    }

## NowAttachmentService : attachmentMetadataPaginator(filter : Filter ? = null, limit : Int ? = null) {#ariaid-title5}

Récupère les métadonnées de toutes les pièces jointes qui répondent aux critères spécifiés et crée un paginateur pour l'itération à travers les pages des métadonnées renvoyées.
Vous pouvez utiliser ce paginateur pour naviguer dans les métadonnées renvoyées, en effectuant 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 en vérifiant s'il existe une page suivante ou précédente.
{#NAttServ-attachMetadataPaginat_S_I__table_npz_zf1_ppb__entry__3}

| Nom | Type | Description |
|-|-|-|
| filtre | [Filtrer](https://servicenow-prod.fluidtopics.net/Lbi2EuldoQUadQ4d8m74sw#FilterAndroidAPI "La classe Filter permet de configurer des filtres qui définissent les données à renvoyer dans les résultats renvoyés d’une requête de point de terminaison REST.") | Facultatif. Chaîne de requête à utiliser pour filtrer les pièces jointes dont les métadonnées doivent être renvoyées. Par défaut : null : renvoie les métadonnées pour toutes les pièces jointes disponibles. Prend en considération le limit paramètre. |
| limite | Entier | Facultatif. Nombre maximal de métadonnées du fichier de pièce jointe à renvoyer. Par défaut : null : renvoie toutes les métadonnées qui répondent aux spécifications du filter paramètre. |
[Tableau 8. Paramètres]

{#NAttServ-attachMetadataPaginat_S_I__table_npz_zf1_ppb} {#NAttServ-attachMetadataPaginat_S_I__table_opz_zf1_ppb__entry__2}

| Type | Description |
|-|-|
| Paginateur \<[NowAttachmentMetadata](https://servicenow-prod.fluidtopics.net/sFPXIItEFniLH7_Bk_vHmQ#NowAttachmentMetadataAndroidAPI "La classe NowAttachmentMetadata fournit des fonctions qui vous permettent d’encoder et de gérer les métadonnées de pièce jointe.")\> | Réussite : objet du paginateur avec les pages spécifiées des métadonnées. Échec : objet NowDataError. |
[Tableau 9. Renvoie]

{#NAttServ-attachMetadataPaginat_S_I__table_opz_zf1_ppb}  
L'exemple de code suivant montre comment appeler cette fonction.

    suspend fun createAttachmentMetadataPaginator() {
      val filterQuery: String = "content_type=text/plain"
      val filter = filterQuery.let(::Filter)
      val limit = 10
      val paginator = nowServiceManager.getNowAttachmentService()?.attachmentMetadataPaginator(filter, limit)
        ?.observe(object : PaginatorCallBack<NowAttachmentMetadata> {
          override fun onFailure(e: NowDataError) {
            handleError(e)
          }

          override fun onSuccess(response: Response<List<NowAttachmentMetadata>>) {
            handleResponse(response)
          }

        })
        ?: throw Exception("Response is null")
    }

## NowAttachmentService : delete(sysId : chaîne) {#ariaid-title6}

Supprime la pièce jointe avec le sys_id spécifié.
{#NAttServ-delete_S__table_dq4_dj1_ppb__entry__3}

| Nom | Type | Description |
|-|-|-|
| sysId | Chaîne | Sys_id de la pièce jointe à supprimer. |
[Tableau 10. Paramètres]

{#NAttServ-delete_S__table_dq4_dj1_ppb} {#NAttServ-delete_S__table_eq4_dj1_ppb__entry__2}

| Type | Description |
|-|-|
| [Appeler](https://servicenow-prod.fluidtopics.net/Ftyw7Yt2YUqnJyFyCGm5lg#CallAndroidInterface "L’interface d’appel représente une demande préparée pour traitement.")\<[ByteArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/)\> | Réussite : rien n'est retourné. Échec : NowDataError renvoyé. |
[Tableau 11. Renvoie]

{#NAttServ-delete_S__table_eq4_dj1_ppb}  
<br />

    fun deleteAttachment(sysId: String) { 
      val call = attachmentService.delete(sysId) 
      call.enqueue( 
        { response -> handleResponse(response) }, 
        { nowDataError -> handleError(nowDataError) } 
      )
    } 

## NowAttachmentService : upload(données : ByteArray, configuration : NowAttachmentUploadConfiguration) {#ariaid-title7}

Récupère les métadonnées de toutes les pièces jointes qui répondent aux critères spécifiés et crée un paginateur pour l'itération à travers les pages des métadonnées renvoyées.
{#NAttServ-upload_A_O__table_fkj_3k1_ppb__entry__3}

| Nom | Type | Description |
|-|-|-|
| données | [Tableau d'octets](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/) | Métadonnées à charger et à associer à la pièce jointe spécifiée dans l'objet de configuration. |
| configuration | NowAttachmentUploadConfiguration | Chargez les paramètres de configuration. |
[Tableau 12. Paramètres]

{#NAttServ-upload_A_O__table_fkj_3k1_ppb} {#NAttServ-upload_A_O__table_gkj_3k1_ppb__entry__2}

| Type | Description |
|-|-|
| [NowAttachmentMetadata (en anglais seulement)](https://servicenow-prod.fluidtopics.net/sFPXIItEFniLH7_Bk_vHmQ#NowAttachmentMetadataAndroidAPI "La classe NowAttachmentMetadata fournit des fonctions qui vous permettent d’encoder et de gérer les métadonnées de pièce jointe.") | Métadonnées chargées. |
[Tableau 13. Renvoie]

{#NAttServ-upload_A_O__table_gkj_3k1_ppb}  

    fun uploadAttachment(tableName: String, recordSysId: String, fileName: String) { 
      val bitmap = BitmapFactory.decodeResource(resources, R.drawable.test_image) 
      val data = bitmap.compress(ImageType.JPEG) 
      val contentType = "image/jpg" 
      val config = NowAttachmentUploadConfiguration(tableName, recordSysId, fileName, contentType) 
      val call = attachmentService.upload(data, config) 
     
      call.enqueue( 
        { response -> 
          val uploadedAttachmentMetadata: NowAttachmentMetadata? = response.body 
        },
        { nowDataError -> handleError(nowDataError) } 
      )
    }