---
sourceDocument: Xanadu API リファレンス
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/ja-JP/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - ja-JP

ft:publication_title :

    - Xanadu API リファレンス

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# NowAttachmentService インターフェイス - Android

# NowAttachmentService インターフェイス - Android {#ariaid-title1}

* リリースバージョン: Xanadu
* 
* 更新日 2024年08月01日
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 所要時間：8分

NowAttachmentService インターフェイスは、添付ファイルとそれに関連するメタデータの操作を可能にする関数を提供します。
{#NowAttachServiceAndroidInterface__table_vx2_klw_5pb__entry__3}

| 名前 | タイプ | Description (説明) |
|-|-|-|
| 構成 | [NowServiceConfiguration](https://servicenow-prod.fluidtopics.net/xUPU640R0L1uwngzAjrqkw "NowServiceConfiguration クラスを使用すると、フィーチャ サービスのServiceNowインスタンス URL とパッケージ名を構成できます。") | サービスに関連付ける構成。 |
[表 : 1. プロパティ]

{#NowAttachServiceAndroidInterface__table_vx2_klw_5pb}

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

指定されたsys_idで添付ファイルを取得し、オプションで、添付ファイルの計算されたハッシュを予想されるハッシュと比較して、添付ファイルを検証します。
{#NAttServ-attachment_S_B__table_old_sp5_4pb__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| sysId | 文字列 | 取得する添付ファイルのSys_id。これは、 ServiceNow インスタンス上の添付ファイルのsys_idです。 |
| validateAttachment | ブーリアン | 添付ファイルを検証するかどうかを示すフラグ。 有効な値： * true:添付ファイルを検証します。 * false:添付ファイルを検証しません。 {#NAttServ-attachment_S_B__ul_ftq_1q5_4pb} デフォルト：true |
[表 : 2. パラメーター]

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

| タイプ | Description (説明) |
|-|-|
| [呼び出し](https://servicenow-prod.fluidtopics.net/B9yfp0bhp_9Z2cEsUjZEIA#CallAndroidInterface "Call インターフェイスは、処理の準備が整った要求を表します。")\<[NowAttachment](https://servicenow-prod.fluidtopics.net/banXXmFj~XL_Dvfv958kBw#NowAttachmentAndroidAPI "NowAttachment クラスは、添付ファイルとそれに関連するメタデータを含むオブジェクトを提供します。")\> | 要求された添付ファイルを含む NowAttachment オブジェクト。 |
[表 : 3. 返される内容]

{#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: 文字列) {#ariaid-title3}

指定されたsys_idに関連付けられた添付ファイルのメタデータを取得します。
{#NAttServ-attachmentMetadata_S__table_bqq_1r5_4pb__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| sysId | 文字列 | メタデータを取得する添付ファイルのSys_id。 |
[表 : 4. パラメーター]

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

| タイプ | Description (説明) |
|-|-|
| \<[NowAttachmentMetadata](https://servicenow-prod.fluidtopics.net/1byTJi65AWfu9k3uUuMXPg#NowAttachmentMetadataAndroidAPI "NowAttachmentMetadata クラスは、添付ファイルのメタデータをエンコードおよび管理できるようにする関数を提供します。")[を呼び出し](https://servicenow-prod.fluidtopics.net/B9yfp0bhp_9Z2cEsUjZEIA#CallAndroidInterface "Call インターフェイスは、処理の準備が整った要求を表します。")ます\> | 指定した添付ファイルのメタデータを含むオブジェクト。 |
[表 : 5. 返される内容]

{#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}

指定されたクライテリアを満たすすべての添付ファイルのメタデータを取得します。
{#NAttServ-attachmentMetadata_S_I___table_ujt_zc1_ppb__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| filter | [フィルター](https://servicenow-prod.fluidtopics.net/gFs_UHYh~4~dfW3NiQuhhg#FilterAndroidAPI "Filter クラスには、REST エンドポイントクエリの戻り値で返すデータを定義するフィルターを構成する機能があります。") | オプション。メタデータを返す添付ファイルをフィルタリングするために使用するクエリ文字列。 デフォルト:null:利用可能なすべての添付ファイルのメタデータを返します。limitパラメーターが考慮されます。 |
| limit | 整数 | オプション。返す添付ファイルのメタデータの最大数。 デフォルト:null: filter パラメーターの仕様を満たすすべてのメタデータを返します。 |
[表 : 6. パラメーター]

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

| タイプ | Description (説明) |
|-|-|
| [Call](https://servicenow-prod.fluidtopics.net/B9yfp0bhp_9Z2cEsUjZEIA#CallAndroidInterface "Call インターフェイスは、処理の準備が整った要求を表します。")\<[List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/)\<[NowAttachmentMetadata](https://servicenow-prod.fluidtopics.net/1byTJi65AWfu9k3uUuMXPg#NowAttachmentMetadataAndroidAPI "NowAttachmentMetadata クラスは、添付ファイルのメタデータをエンコードおよび管理できるようにする関数を提供します。")\>\> | 一致する添付ファイルのメタデータを含むオブジェクトのリスト。 |
[表 : 7. 返される内容]

{#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}

指定された基準を満たすすべての添付ファイルのメタデータを取得し、返されたメタデータのページを反復処理するためのページネーターを作成します。
このページネーターを使用して、返されたメタデータ間を移動し、最初、最後、前、または次のページのフェッチや、次のページまたは前のページがあるかどうかの確認などのナビゲーション操作を実行できます。
{#NAttServ-attachMetadataPaginat_S_I__table_npz_zf1_ppb__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| filter | [フィルター](https://servicenow-prod.fluidtopics.net/gFs_UHYh~4~dfW3NiQuhhg#FilterAndroidAPI "Filter クラスには、REST エンドポイントクエリの戻り値で返すデータを定義するフィルターを構成する機能があります。") | オプション。メタデータを返す添付ファイルをフィルタリングするために使用するクエリ文字列。 デフォルト:null:利用可能なすべての添付ファイルのメタデータを返します。limitパラメーターが考慮されます。 |
| limit | 整数 | オプション。返す添付ファイルのメタデータの最大数。 デフォルト:null: filter パラメーターの仕様を満たすすべてのメタデータを返します。 |
[表 : 8. パラメーター]

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

| タイプ | Description (説明) |
|-|-|
| Paginator\<[NowAttachmentMetadata](https://servicenow-prod.fluidtopics.net/1byTJi65AWfu9k3uUuMXPg#NowAttachmentMetadataAndroidAPI "NowAttachmentMetadata クラスは、添付ファイルのメタデータをエンコードおよび管理できるようにする関数を提供します。")\> | 成功: Paginator オブジェクトとメタデータの指定されたページ。 失敗:NowDataError オブジェクト。 |
[表 : 9. 返される内容]

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

    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: 文字列) {#ariaid-title6}

指定したsys_idの添付ファイルを削除します。
{#NAttServ-delete_S__table_dq4_dj1_ppb__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| sysId | 文字列 | 削除する添付ファイルの sys_id。 |
[表 : 10. パラメーター]

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

| タイプ | Description (説明) |
|-|-|
| [Call](https://servicenow-prod.fluidtopics.net/B9yfp0bhp_9Z2cEsUjZEIA#CallAndroidInterface "Call インターフェイスは、処理の準備が整った要求を表します。")\<[ByteArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/)\> | 成功:何も返されません。 失敗:NowDataError が返されました。 |
[表 : 11. 返される内容]

{#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(データ:ByteArray、構成:NowAttachmentUploadConfiguration) {#ariaid-title7}

指定された基準を満たすすべての添付ファイルのメタデータを取得し、返されたメタデータのページを反復処理するためのページネータを作成します。
{#NAttServ-upload_A_O__table_fkj_3k1_ppb__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| データ | [バイトアレイ](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/) | アップロードして構成オブジェクトで指定された添付ファイルに関連付けるメタデータ。 |
| 構成 | NowAttachmentUploadConfiguration | 設定パラメーターをアップロードします。 |
[表 : 12. パラメーター]

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

| タイプ | Description (説明) |
|-|-|
| [NowAttachmentMetadata](https://servicenow-prod.fluidtopics.net/1byTJi65AWfu9k3uUuMXPg#NowAttachmentMetadataAndroidAPI "NowAttachmentMetadata クラスは、添付ファイルのメタデータをエンコードおよび管理できるようにする関数を提供します。") | メタデータがアップロードされました。 |
[表 : 13. 返される内容]

{#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) } 
      )
    }