CSM 添付ファイル API

  • リリースバージョン: Yokohama
  • 更新日 2025年01月30日
  • 所要時間：43分

    • CSM 添付ファイル API は、内部と外部の両方のユーザーが、テーブルに関連付けられた添付ファイルのアップロード、ダウンロード、削除や、添付ファイルメタデータの取得を行えるようにするエンドポイントを提供します。

    glide.rest.attachment_csm_api.allowed_tables システムプロパティで指定されたテーブルに関連付けられた添付ファイルのみが、関連付けられたエンドポイント呼び出しで有効です。ログインしているユーザーは誰でも (snc_internal と snc_external の両方)、この API にアクセスできます。ゲストとパブリックユーザーにはアクセス権がありません。

    この API は、アップロードされたファイルに関するシステム制限 (最大ファイルサイズや許可された添付ファイルタイプなど) に従います。これらの設定は、com.glide.attachment.max_size および glide.attachment.extensions プロパティを使用して制御できます。

    デフォルトでは、非認証ユーザーおよび snc_external ユーザーに対して、この API には 1 時間当たり 500 のレート制限があります。レート制限の詳細については、「 受信 REST API のレート制限」を参照してください。

    CSM 添付ファイル - DELETE /now/attachment_csm/{sys_id}

    指定した添付ファイルを削除します。

    URL 形式

    バージョニングされた URL：/api/now/{api_version}/attachment_csm/{sys_id}

    デフォルトの URL：/api/now/v1/attachment_csm/{sys_id}

    注:
    利用可能なバージョンは、 REST API エクスプローラーで指定されます。スクリプト済み REST API の場合、[ スクリプト済み REST サービス] フォームに追加のバージョン情報があります。

    サポートされている要求パラメーター

    表 : 1. パスパラメーター
    名前 説明
    api_version オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。

    データタイプ：文字列
    sys_id 削除する添付ファイルの sys_id。この添付ファイルは、システムプロパティ [sys_properties] テーブルの glide.rest.attachment_csm_api.allowed_tables プロパティ内にリストされているテーブルの 1 つに属している必要があります。

    データタイプ：文字列
    表 : 2. クエリパラメーター
    名前 説明
    なし
    表 : 3. 要求本文パラメーター (XML または JSON)
    名前 説明
    なし

    ヘッダー

    次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。

    表 : 4. 要求ヘッダー
    ヘッダー 説明
    なし
    表 : 5. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

    この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

    表 : 6. ステータスコード
    ステータスコード 説明
    204 成功。要求が正常に完了したことを示します。
    400 要求が正しくありません。このテーブルの添付ファイルにアクセスできない可能性があることを示します。関連付けられたテーブルが glide.rest.attachment_csm_api.allowed_tables システムプロパティに含まれていることを確認します。
    401 権限がありません。ユーザー資格情報が間違っているか、渡されていません。
    404 見つかりません。要求されたアイテムが見つかりませんでした。
    500 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

    応答本文のパラメーター (JSON または XML)

    名前 説明
    なし

    サンプル cURL 要求

    curl "https://instance.servicenow.com/api/now/v1/attachment_csm/615ea769c0a80166001cf5f2367302f5" \
--request DELETE \
--user 'username':'password'
    None

    CSM 添付ファイル - GET /now/attachment_csm

    複数の添付ファイルのメタデータを返します。

    注:
    フルネームまたは短縮名 (sysparm_ プリフィックスなし) を使用して、すべての sysparm クエリパラメーターを参照できます。たとえば、sysparm_limit の場合は limit も使用できます。

    URL 形式

    バージョニングされた URL：/api/now/{api_version}/attachment_csm

    デフォルトの URL：/api/now/v1/attachment_csm

    注:
    利用可能なバージョンは、 REST API エクスプローラーで指定されます。スクリプト済み REST API の場合、[ スクリプト済み REST サービス] フォームに追加のバージョン情報があります。

    サポートされている要求パラメーター

    表 : 7. パスパラメーター
    名前 説明
    api_version オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。

    データタイプ：文字列
    表 : 8. クエリパラメーター
    名前 説明
    sysparm_limit 返されるレコードの最大数。このレコード数を超える要求の場合は、sysparm_offset パラメーターを使用してレコード取得をページネーションします。

    この制限は、ACL 評価の前に適用されます。アクセスできるレコードが含まれているのにレコードが何も返されない場合は、アクセスできるレコードが最初に返されるようにレコードの順序を並べ替えます。

    注:
    異常に大きい sysparm_limit 値はシステムパフォーマンスに影響する可能性があります。

    データタイプ：数値

    デフォルト値：20

    最大：100
    sysparm_offset レコード取得を開始するレコードのインデックス。この値を使用して、レコード取得をページネーションします。この機能により、レコード数に関係なく、管理しやすい小さなチャンクに分割してすべてのレコードを取得できます。

    たとえば、このエンドポイントを初めて呼び出すときに、sysparm_offset は「0」に設定されます。単に利用可能なすべてのレコードをページングするには、すべてのレコードの終わりに達するまで「sysparm_offset=sysparm_offset+sysparm_limit」を使用します。

    sysparm_offset パラメーターに負の数を渡さないでください。

    データタイプ：数値

    デフォルト：0
    sysparm_query 必須です。添付ファイルの検索に使用するエンコードクエリー。

    このパラメーターには少なくとも sysparm_query=table_name=<table> が含まれている必要があります。ここで <table> には、システムプロパティ [sys_properties] テーブルにある glide.rest.attachment_csm_api.allowed_tables プロパティで指定されたテーブルのみを使用できます。

    例：sysparm_query=file_name=kb_knowledge。

    構文：sysparm_query=<col_name><operator><value>。
    • <col_name>：フィルターを適用するテーブル列の名前。
    • <operator>：次の値をサポートします。
      • =：<value> と完全一致します。
      • !=：<value> と一致しません。
      • ^：複数のクエリステートメントの論理 AND。
      • ^OR：複数のクエリステートメントの論理 OR。
      • LIKE：指定された文字列が <col_name> に含まれています。データタイプが文字列である <col_name> フィールドに対してのみ機能します。
      • STARTSWITH：<col_name> は指定された文字列で始まります。データタイプが文字列である <col_name> フィールドに対してのみ機能します。
      • ENDSWITH：<col_name> は指定した文字列で終了します。データタイプが文字列である <col_name> フィールドに対してのみ機能します。
      <value>：照合する値。

    すべてのパラメーターで大文字と小文字が区別されます。クエリには、sysparm_query=<col_name><operator><value>[<operator><col_name><operator><value>] のように、複数のエントリを含めることができます。

    例：

    (sysparm_query=caller_id=javascript:gs.getUserID()^active=true)

    エンコードされたクエリは、機能別の順番もサポートしています。特定のフィールドに基づいて回答を並べ替えるには、ORDERBY と ORDERBYDESC の句を sysparm_query で使用します。

    構文：
    • ORDERBY<col_name>
    • ORDERBYDESC<col_name>

    例：sysparm_query=active=true^ORDERBYnumber^ORDERBYDESCcategory

    このクエリは、すべてのアクティブなレコードをフィルタリングし、結果を番号で昇順に並べ替えた後、カテゴリで降順に並べ替えます。

    データタイプ：文字列
    表 : 9. 要求本文パラメーター (XML または JSON)
    名前 説明
    なし

    ヘッダー

    次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。

    表 : 10. 要求ヘッダー
    ヘッダー 説明
    承認 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。

    デフォルト： application/json
    表 : 11. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

    この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

    表 : 12. ステータスコード
    ステータスコード 説明
    200 成功。要求が正常に処理されました。
    401 権限がありません。ユーザー資格情報が間違っているか、渡されていません。
    500 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

    応答本文のパラメーター (JSON または XML)

    要素 説明
    result 要求された添付ファイルのメタデータ。

    データタイプ：オブジェクト

    "result": {
  "average_image_color": "String",
  "compressed": "String", 
  "content_type": "String",
  "created_by_name": "String",
  "download_link": "String",
  "file_name": "String",
  "image_height": "String",
  "image_width": "String",
  "size_bytes": "String",
  "size_compressed": "String",
  "sys_created_by": "String",
  "sys_created_on": "String",
  "sys_id": "String",
  "sys_mod_count": "String",
  "sys_tags": "String",
  "sys_updated_by": "String",
  "sys_updated_on": "String",
  "table_name": "String",
  "table_sys_id": "String",
  "updated_by_name": "String"
}
    result.average_image_color 添付ファイルが画像の場合は、すべての色の合計。

    データタイプ：文字列

    単位：RGB またはピクセル数。
    result.compressed 添付ファイルが圧縮されているかどうかを示すフラグ。
    可能な値：
    • true：ファイルは圧縮されています。
    • false：ファイルは圧縮されていません。

    データタイプ：文字列
    result.content_type 関連付けられた添付ファイルのコンテンツタイプ (image、 jpeg、 application/x-shockflow-flash など)。

    データタイプ：文字列
    result.created_by_name 添付ファイルを最初に作成したエンティティのフルネーム。

    データタイプ：文字列
    result.download_link ServiceNow インスタンスの添付ファイルのダウンロード URL。

    データタイプ：文字列
    result.file_name 添付ファイルのファイル名。

    データタイプ：文字列
    result.image_height 画像ファイルの場合、画像の高さ。

    データタイプ：文字列

    単位：ピクセル
    result.image_width 画像ファイルの場合、画像の幅。

    データタイプ：文字列

    単位：ピクセル
    result.size_bytes 添付ファイルのサイズ。

    データタイプ：文字列

    単位：バイト
    result.size_compressed 圧縮された添付ファイルのサイズ。ファイルが圧縮されていない場合は、空になります。

    データタイプ：文字列

    単位：バイト
    result.sys_created_by 添付ファイルを最初に作成したエンティティ。

    データタイプ：文字列
    result.sys_created_on 添付ファイルが最初にインスタンスに保存された日時。

    データタイプ：文字列
    result.sys_id 添付ファイルの sys_id。

    データタイプ：文字列
    result.sys_mod_count 添付ファイルが変更された (インスタンスにアップロードされた) 回数。

    データタイプ：文字列
    result.sys_tags 添付ファイルに関連付けられているシステムタグ。

    データタイプ：文字列
    result.sys_updated_by 添付ファイルを最後に更新したエンティティ。

    データタイプ：文字列
    result.sys_updated_on 添付ファイルが最後に更新された日時。

    データタイプ：文字列
    result.table_name 添付ファイルが関連付けられたテーブルの名前。

    データタイプ：文字列
    result.table_sys_id 添付ファイルに関連付けられたテーブルの sys_id。

    データタイプ：文字列
    result.updated_by_name 添付ファイルを最後に更新したエンティティのフルネーム。

    データタイプ：文字列

    サンプル cURL 要求

    curl "https://instance.service-now.com/api/now/v1/attachment_csm?sysparm_limit=1" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
    {
  "result": [
    {
      "table_sys_id": "5054b6f8c0a800060056addcf551ecf8",
      "size_bytes": "462",
      "download_link": "https://instance.service-now.com/api/now/v1/attachment_csm/615ea769c0a80166001cf5f2367302f5/file",
      "sys_updated_on": "2009-05-21 04:12:21",
      "sys_id": "615ea769c0a80166001cf5f2367302f5",
      "image_height": "",
      "sys_created_on": "2009-05-21 04:12:21",
      "file_name": "blocks.swf",
      "sys_created_by": "glide.maint",
      "compressed": "true",
      "average_image_color": "",
      "sys_updated_by": "glide.maint",
      "sys_tags": "",
      "table_name": "content_block_programmatic",
      "image_width": "",
      "sys_mod_count": "0",
      "content_type": "application/x-shockwave-flash",
      "size_compressed": "485",
      "created_by_name": "John Smith",
      "updated_by_name": "John Smith"
    }
  ]
}

    CSM 添付ファイル - GET /now/attachment_csm/{sys_id}/file

    指定された添付ファイル sys_id の添付ファイルを返します。

    URL 形式

    バージョニングされた URL：/api/now/{api_version}/attachment_csm/{sys_id}/file

    デフォルトの URL：/api/now/v1/attachment_csm/{sys_id}/file

    注:
    利用可能なバージョンは、 REST API エクスプローラーで指定されます。スクリプト済み REST API の場合、[ スクリプト済み REST サービス] フォームに追加のバージョン情報があります。

    サポートされている要求パラメーター

    表 : 13. パスパラメーター
    名前 説明
    api_version オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。

    データタイプ：文字列
    sys_id 添付ファイルの sys_id。この添付ファイルは、システムプロパティ [sys_properties] テーブルの glide.rest.attachment_csm_api.allowed_tables プロパティ内にリストされているテーブルの 1 つに属している必要があります。

    データタイプ：文字列

    テーブル:添付ファイル [sys_attachment]
    表 : 14. クエリパラメーター
    名前 説明
    なし
    表 : 15. 要求本文パラメーター (XML または JSON)
    名前 説明
    なし

    ヘッダー

    次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。

    表 : 16. 要求ヘッダー
    ヘッダー 説明
    Accept 応答本文のデータフォーマット。たとえば、JPEG または PNG 画像ファイルのみを受け入れるには、image/jpeg または image/png を使用します。すべての画像タイプを許可するには image/*を指定し、あらゆるファイルタイプを許可するには */* を指定します。

    デフォルト：*/*
    表 : 17. 応答ヘッダー
    ヘッダー 説明
    X-Attachment-Metadata 返されるファイルに関するメタデータ (サイズ、名前、ファイルタイプなど)。

    ステータスコード

    この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

    表 : 18. ステータスコード
    ステータスコード 説明
    200 成功。要求が正常に処理されました。
    400 要求が正しくありません。このテーブルの添付ファイルにアクセスできない可能性があることを示します。関連付けられたテーブルが glide.rest.attachment_csm_api.allowed_tables システムプロパティに含まれていることを確認します。
    401 権限がありません。ユーザー資格情報が間違っているか、渡されていません。
    500 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

    応答本文のパラメーター

    名前 説明
    添付ファイルのコンテンツ。

    サンプル cURL 要求

    curl "https://instance.servicenow.com/api/now/v1/attachment_csm/<attachment_sys_id>/file" \
--request GET \
--header "Accept:*/*" \
--user 'username':'password'
    Recipient list Internal users Sheet1
sys_id	email
 Recipient list Internal users.xlsx

    CSM 添付ファイル - GET /now/attachment_csm/{sys_id}

    特定の添付ファイル sys_id を持つ添付ファイルのメタデータを返します。

    URL 形式

    バージョニングされた URL：/api/now/{api_version}/attachment_csm/{sys_id}

    デフォルトの URL：/api/now/v1/attachment_csm/{sys_id}

    注:
    利用可能なバージョンは、 REST API エクスプローラーで指定されます。スクリプト済み REST API の場合、[ スクリプト済み REST サービス] フォームに追加のバージョン情報があります。

    サポートされている要求パラメーター

    表 : 19. パスパラメーター
    名前 説明
    api_version オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。

    データタイプ：文字列
    sys_id メタデータを返す添付ファイルレコードの sys_id。この添付ファイルは、システムプロパティ [sys_properties] テーブルの glide.rest.attachment_csm_api.allowed_tables プロパティ内にリストされているテーブルの 1 つに属している必要があります。

    データタイプ：文字列
    表 : 20. クエリパラメーター
    名前 説明
    なし
    表 : 21. 要求本文パラメーター (XML または JSON)
    名前 説明
    なし

    ヘッダー

    次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。

    表 : 22. 要求ヘッダー
    ヘッダー 説明
    承認 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。

    デフォルト： application/json
    表 : 23. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

    この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

    表 : 24. ステータスコード
    ステータスコード 説明
    200 成功。要求が正常に処理されました。
    400 要求が正しくありません。このテーブルの添付ファイルにアクセスできない可能性があることを示します。関連付けられたテーブルが glide.rest.attachment_csm_api.allowed_tables システムプロパティに含まれていることを確認します。
    401 権限がありません。ユーザー資格情報が正しくありません。
    404 見つかりません。指定された添付ファイルが存在しないか、現在のユーザーにそのファイルのアクセス権限がないことを示します。
    500 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

    応答本文のパラメーター (JSON または XML)

    要素 説明
    result 要求された添付ファイルのメタデータ。

    データタイプ：オブジェクト

    "result": {
  "average_image_color": "String",
  "compressed": "String", 
  "content_type": "String",
  "created_by_name": "String",
  "download_link": "String",
  "file_name": "String",
  "image_height": "String",
  "image_width": "String",
  "size_bytes": "String",
  "size_compressed": "String",
  "sys_created_by": "String",
  "sys_created_on": "String",
  "sys_id": "String",
  "sys_mod_count": "String",
  "sys_tags": "String",
  "sys_updated_by": "String",
  "sys_updated_on": "String",
  "table_name": "String",
  "table_sys_id": "String",
  "updated_by_name": "String"
}
    result.average_image_color 添付ファイルが画像の場合は、すべての色の合計。

    データタイプ：文字列

    単位：RGB またはピクセル数。
    result.compressed 添付ファイルが圧縮されているかどうかを示すフラグ。
    可能な値：
    • true：ファイルは圧縮されています。
    • false：ファイルは圧縮されていません。

    データタイプ：文字列
    result.content_type 関連付けられた添付ファイルのコンテンツタイプ (image、 jpeg、 application/x-shockflow-flash など)。

    データタイプ：文字列
    result.created_by_name 添付ファイルを最初に作成したエンティティのフルネーム。

    データタイプ：文字列
    result.download_link ServiceNow インスタンスの添付ファイルのダウンロード URL。

    データタイプ：文字列
    result.file_name 添付ファイルのファイル名。

    データタイプ：文字列
    result.image_height 画像ファイルの場合、画像の高さ。

    データタイプ：文字列

    単位：ピクセル
    result.image_width 画像ファイルの場合、画像の幅。

    データタイプ：文字列

    単位：ピクセル
    result.size_bytes 添付ファイルのサイズ。

    データタイプ：文字列

    単位：バイト
    result.size_compressed 圧縮された添付ファイルのサイズ。ファイルが圧縮されていない場合は、空になります。

    データタイプ：文字列

    単位：バイト
    result.sys_created_by 添付ファイルを最初に作成したエンティティ。

    データタイプ：文字列
    result.sys_created_on 添付ファイルが最初にインスタンスに保存された日時。

    データタイプ：文字列
    result.sys_id 添付ファイルの sys_id。

    データタイプ：文字列
    result.sys_mod_count 添付ファイルが変更された (インスタンスにアップロードされた) 回数。

    データタイプ：文字列
    result.sys_tags 添付ファイルに関連付けられているシステムタグ。

    データタイプ：文字列
    result.sys_updated_by 添付ファイルを最後に更新したエンティティ。

    データタイプ：文字列
    result.sys_updated_on 添付ファイルが最後に更新された日時。

    データタイプ：文字列
    result.table_name 添付ファイルが関連付けられたテーブルの名前。

    データタイプ：文字列
    result.table_sys_id 添付ファイルに関連付けられたテーブルの sys_id。

    データタイプ：文字列
    result.updated_by_name 添付ファイルを最後に更新したエンティティのフルネーム。

    データタイプ：文字列

    サンプル cURL 要求

    curl "https://instance.servicenow.com/api/now/v1/attachment_csm/615ea769c0a80166001cf5f2367302f5" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
    {
  "result": {
    "table_sys_id": "5054b6f8c0a800060056addcf551ecf8",
    "size_bytes": "462",
    "download_link": "https://instance.service-now.com/api/now/v1/attachment_csm/615ea769c0a80166001cf5f2367302f5/file",
    "sys_updated_on": "2019-05-21 04:12:21",
    "sys_id": "615ea769c0a80166001cf5f2367302f5",
    "image_height": "",
    "sys_created_on": "2019-05-21 04:12:21",
    "file_name": "blocks.swf",
    "sys_created_by": "glide.maint",
    "compressed": "true",
    "average_image_color": "",
    "sys_updated_by": "glide.maint",
    "sys_tags": "",
    "table_name": "content_block_programmatic",
    "image_width": "",
    "sys_mod_count": "0",
    "content_type": "application/x-shockwave-flash",
    "size_compressed": "485",
    "created_by_name": "John Smith",
    "updated_by_name": "John Smith"
  }
}

    CSM 添付ファイル - POST /now/attachment_csm/file

    指定されたバイナリファイルを、指定されたレコードの添付ファイルとしてアップロードします。

    エンドポイントは、保存された添付ファイルのメタデータも返します。

    URL 形式

    バージョニングされた URL：/api/now/{api_version}/attachment_csm/file

    デフォルトの URL：/api/now/v1/attachment_csm/file

    注:
    利用可能なバージョンは、 REST API エクスプローラーで指定されます。スクリプト済み REST API の場合、[ スクリプト済み REST サービス] フォームに追加のバージョン情報があります。

    サポートされている要求パラメーター

    表 : 25. パスパラメーター
    名前 説明
    api_version オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。

    データタイプ：文字列
    表 : 26. クエリパラメーター
    名前 説明
    encryption_context 暗号化コンテキストレコードの sys_id。指定された暗号化コンテキストを持つユーザーのみが添付ファイルにアクセスできるようにするには、このパラメーターを指定します。暗号化コンテキストレコードの詳細については、「 Field Encryption」を参照してください。

    データタイプ：文字列

    デフォルト：添付ファイルはどの暗号化コンテキストでも暗号化されません。
    file_name 必須です。添付ファイルに付ける名前。
    注:
    添付するファイルは、渡されるクエリパラメーターリストの最後のパラメーターの後に指定する必要があります。

    データタイプ：文字列
    table_name 必須です。ファイルを添付するテーブルの名前。このテーブルは、システムプロパティ [sys_properties] テーブルの glide.rest.attachment_csm_api.allowed_tables システムプロパティ内にリストされている必要があります。

    データタイプ：文字列
    table_sys_id 必須です。指定されたテーブルの、ファイルを添付するレコードの sys_id。

    データタイプ：文字列
    表 : 27. 要求本文パラメーター (XML または JSON)
    名前 説明
    <文字列> 指定されたレコードに添付するバイナリファイルへのパス。

    データタイプ：文字列

    ヘッダー

    次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。

    表 : 28. 要求ヘッダー
    ヘッダー 説明
    承認 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。

    デフォルト： application/json
    Content-Type 必須です。ポストするファイルのデータ形式。たとえば、JPEG または PNG 画像ファイルのみをポストするには、image/jpeg または image/png を使用します。すべての画像タイプを許可するには image/*を指定し、あらゆるファイルタイプを許可するには */* を指定します。
    表 : 29. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

    この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

    表 : 30. ステータスコード
    ステータスコード 説明
    200 成功。要求が正常に処理されました。
    400 要求が正しくありません。このテーブルの添付ファイルにアクセスできない可能性があることを示します。関連付けられたテーブルが glide.rest.attachment_csm_api.allowed_tables システムプロパティに含まれていることを確認します。
    401 権限がありません。ユーザー資格情報が間違っているか、渡されていません。
    404 見つかりません。table_name および table_sys_id パラメーターで指定されたレコードが存在しないか、現在のユーザーがアクセスできないことを示します。
    500 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

    応答本文のパラメーター (JSON または XML)

    要素 説明
    result 要求された添付ファイルのメタデータ。

    データタイプ：オブジェクト

    "result": {
  "average_image_color": "String",
  "compressed": "String", 
  "content_type": "String",
  "created_by_name": "String",
  "download_link": "String",
  "file_name": "String",
  "image_height": "String",
  "image_width": "String",
  "size_bytes": "String",
  "size_compressed": "String",
  "sys_created_by": "String",
  "sys_created_on": "String",
  "sys_id": "String",
  "sys_mod_count": "String",
  "sys_tags": "String",
  "sys_updated_by": "String",
  "sys_updated_on": "String",
  "table_name": "String",
  "table_sys_id": "String",
  "updated_by_name": "String"
}
    result.average_image_color 添付ファイルが画像の場合は、すべての色の合計。

    データタイプ：文字列

    単位：RGB またはピクセル数。
    result.compressed 添付ファイルが圧縮されているかどうかを示すフラグ。
    可能な値：
    • true：ファイルは圧縮されています。
    • false：ファイルは圧縮されていません。

    データタイプ：文字列
    result.content_type 関連付けられた添付ファイルのコンテンツタイプ (image、 jpeg、 application/x-shockflow-flash など)。

    データタイプ：文字列
    result.created_by_name 添付ファイルを最初に作成したエンティティのフルネーム。

    データタイプ：文字列
    result.download_link ServiceNow インスタンスの添付ファイルのダウンロード URL。

    データタイプ：文字列
    result.file_name 添付ファイルのファイル名。

    データタイプ：文字列
    result.image_height 画像ファイルの場合、画像の高さ。

    データタイプ：文字列

    単位：ピクセル
    result.image_width 画像ファイルの場合、画像の幅。

    データタイプ：文字列

    単位：ピクセル
    result.size_bytes 添付ファイルのサイズ。

    データタイプ：文字列

    単位：バイト
    result.size_compressed 圧縮された添付ファイルのサイズ。ファイルが圧縮されていない場合は、空になります。

    データタイプ：文字列

    単位：バイト
    result.sys_created_by 添付ファイルを最初に作成したエンティティ。

    データタイプ：文字列
    result.sys_created_on 添付ファイルが最初にインスタンスに保存された日時。

    データタイプ：文字列
    result.sys_id 添付ファイルの sys_id。

    データタイプ：文字列
    result.sys_mod_count 添付ファイルが変更された (インスタンスにアップロードされた) 回数。

    データタイプ：文字列
    result.sys_tags 添付ファイルに関連付けられているシステムタグ。

    データタイプ：文字列
    result.sys_updated_by 添付ファイルを最後に更新したエンティティ。

    データタイプ：文字列
    result.sys_updated_on 添付ファイルが最後に更新された日時。

    データタイプ：文字列
    result.table_name 添付ファイルが関連付けられたテーブルの名前。

    データタイプ：文字列
    result.table_sys_id 添付ファイルに関連付けられたテーブルの sys_id。

    データタイプ：文字列
    result.updated_by_name 添付ファイルを最後に更新したエンティティのフルネーム。

    データタイプ：文字列

    サンプル cURL 要求

    /images ディレクトリにある .jpg ファイル (Issue_screenshot.jpg) をアップロードする方法を示します。

    curl "https://instance.servicenow.com/api/now/v1/attachment_csm/file?table_name=incident&table_sys_id=d71f7935c0a8016700802b64c67c11c6&file_name=Issue_screenshot" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type: image/jpeg" \
--user "username":"password" \
--data-binary "@/images/Issue_screenshot.jpg"
    {
  "result": {
    "table_sys_id": "d71f7935c0a8016700802b64c67c11c6",
    "size_bytes": "36597",
    "download_link": "https://instance.service-now.com/api/now/v1/attachment_csm/6ea10fe64f411200adf9f8e18110c739/file",
    "sys_updated_on": "2019-01-22 15:14:07",
    "sys_id": "6ea10fe64f411200adf9f8e18110c739",
    "image_height": "",
    "sys_created_on": "2019-01-22 15:14:07",
    "file_name": "Issue_screenshot",
    "sys_created_by": "username",
    "compressed": "true",
    "average_image_color": "",
    "sys_updated_by": "username",
    "sys_tags": "",
    "table_name": "incident",
    "image_width": "",
    "sys_mod_count": "0",
    "content_type": "image/jpeg",
    "size_compressed": "25130",
    "created_by_name": "John Smith",
    "updated_by_name": "John Smith"
  }
}

    CSM 添付ファイル - POST /now/attachment_csm/upload

    マルチパート添付ファイルをアップロードします。

    マルチパート POST メソッドはパラメーターを受け入れません。フォーム本体内でテーブル名とレコード sys_id 値を指定する必要があります。multipart/form-data 要求のサンプルについては、以下の cURL の例を参照してください。
    注:
    マルチパート POST を使用する場合は、ファイルコンテンツがメッセージの最後の部分のみに含まれていることを確認してください。前の部分には、テーブル名やレコード sys_id などのメタデータのみを含める必要があります。
    添付ファイルをアップロードするために multipart/form-data POST 要求を送信する場合は、添付ファイルデータを URL パラメーターまたは要求本文ではなく、フォーム本文に含めます。
    表 : 31. 必須の値
    値 説明
    Content-Type マルチパートアップロードのメッセージ本文に含まれる、ファイルのコンテンツタイプ。
    注:
    フォームデータ内ではなく、POST メッセージのファイル部分内で Content-Type を定義する必要があります。

    データタイプ：文字列
    table_name ファイルを添付するテーブルの名前。このテーブルは、システムプロパティ [sys_properties] テーブルの glide.rest.attachment_csm_api.allowed_tables プロパティ内に指定されている必要があります。

    データタイプ：文字列
    table_sys_id 指定されたテーブルの、ファイルを添付するレコードの sys_id。

    データタイプ：文字列

    URL 形式

    バージョニングされた URL：/api/now/{api_version}/attachment_csm/upload

    デフォルトの URL：/api/now/v1/attachment_csm/upload

    注:
    利用可能なバージョンは、 REST API エクスプローラーで指定されます。スクリプト済み REST API の場合、[ スクリプト済み REST サービス] フォームに追加のバージョン情報があります。

    サポートされている要求パラメーター

    表 : 32. パスパラメーター
    名前 説明
    api_version オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。

    データタイプ：文字列
    表 : 33. クエリパラメーター
    名前 説明
    なし
    表 : 34. 要求本文パラメーター (XML または JSON)
    名前 説明
    なし

    ヘッダー

    次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。

    表 : 35. 要求ヘッダー
    ヘッダー 説明
    Content-Type 要求本文のデータ形式。マルチパート POST メソッドを使用する場合は、この値を multipart/form-data に設定します。
    表 : 36. 応答ヘッダー
    ヘッダー 説明
    場所 ServiceNow プラットフォームインスタンスの新しい添付ファイルの URL。

    ステータスコード

    この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

    表 : 37. ステータスコード
    ステータスコード 説明
    201 成功。要求が正常に完了したことを示します。
    400 要求が正しくありません。このテーブルの添付ファイルにアクセスできない可能性があることを示します。関連付けられたテーブルが glide.rest.attachment_csm_api.allowed_tables システムプロパティに含まれていることを確認します。
    401 権限がありません。ユーザー資格情報が間違っているか、渡されていません。
    404 見つかりません。要求アイテムが見つかりませんでした。
    500 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。

    応答本文のパラメーター (JSON または XML)

    要素 説明
    result 要求された添付ファイルのメタデータ。

    データタイプ：オブジェクト

    "result": {
  "average_image_color": "String",
  "compressed": "String", 
  "content_type": "String",
  "created_by_name": "String",
  "download_link": "String",
  "file_name": "String",
  "image_height": "String",
  "image_width": "String",
  "size_bytes": "String",
  "size_compressed": "String",
  "sys_created_by": "String",
  "sys_created_on": "String",
  "sys_id": "String",
  "sys_mod_count": "String",
  "sys_tags": "String",
  "sys_updated_by": "String",
  "sys_updated_on": "String",
  "table_name": "String",
  "table_sys_id": "String",
  "updated_by_name": "String"
}
    result.average_image_color 添付ファイルが画像の場合は、すべての色の合計。

    データタイプ：文字列

    単位：RGB またはピクセル数。
    result.compressed 添付ファイルが圧縮されているかどうかを示すフラグ。
    可能な値：
    • true：ファイルは圧縮されています。
    • false：ファイルは圧縮されていません。

    データタイプ：文字列
    result.content_type 関連付けられた添付ファイルのコンテンツタイプ (image、 jpeg、 application/x-shockflow-flash など)。

    データタイプ：文字列
    result.created_by_name 添付ファイルを最初に作成したエンティティのフルネーム。

    データタイプ：文字列
    result.download_link ServiceNow インスタンスの添付ファイルのダウンロード URL。

    データタイプ：文字列
    result.file_name 添付ファイルのファイル名。

    データタイプ：文字列
    result.image_height 画像ファイルの場合、画像の高さ。

    データタイプ：文字列

    単位：ピクセル
    result.image_width 画像ファイルの場合、画像の幅。

    データタイプ：文字列

    単位：ピクセル
    result.size_bytes 添付ファイルのサイズ。

    データタイプ：文字列

    単位：バイト
    result.size_compressed 圧縮された添付ファイルのサイズ。ファイルが圧縮されていない場合は、空になります。

    データタイプ：文字列

    単位：バイト
    result.sys_created_by 添付ファイルを最初に作成したエンティティ。

    データタイプ：文字列
    result.sys_created_on 添付ファイルが最初にインスタンスに保存された日時。

    データタイプ：文字列
    result.sys_id 添付ファイルの sys_id。

    データタイプ：文字列
    result.sys_mod_count 添付ファイルが変更された (インスタンスにアップロードされた) 回数。

    データタイプ：文字列
    result.sys_tags 添付ファイルに関連付けられているシステムタグ。

    データタイプ：文字列
    result.sys_updated_by 添付ファイルを最後に更新したエンティティ。

    データタイプ：文字列
    result.sys_updated_on 添付ファイルが最後に更新された日時。

    データタイプ：文字列
    result.table_name 添付ファイルが関連付けられたテーブルの名前。

    データタイプ：文字列
    result.table_sys_id 添付ファイルに関連付けられたテーブルの sys_id。

    データタイプ：文字列
    result.updated_by_name 添付ファイルを最後に更新したエンティティのフルネーム。

    データタイプ：文字列

    サンプル cURL 要求

    curl "https://instance.service-now.com/api/now/v1/attachment_csm/upload" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:multipart/form-data" \
--user "username":"password" \
 -F "table_name=incident" \
 -F "table_sys_id=d71f7935c0a8016700802b64c67c11c6" \
 -F "uploadFile=@/image/banner-CS0001345_v1_1.jpeg"

    {
  "result": {
    "table_sys_id": "d71f7935c0a8016700802b64c67c11c6",
    "size_bytes": "36597",
    "download_link": "https://instance.service-now.com/api/now/v1/attachment_csm/994adbc64f511200adf9f8e18110c796/file",
    "sys_updated_on": "2019-02-02 14:00:21",
    "sys_id": "994adbc64f511200adf9f8e18110c796",
    "image_height": "",
    "sys_created_on": "2019-02-02 14:00:21",
    "file_name": "banner-CS0001345_v1_1.jpeg",
    "sys_created_by": "username",
    "compressed": "true",
    "average_image_color": "",
    "sys_updated_by": "username",
    "sys_tags": "",
    "table_name": "incident",
    "image_width": "",
    "sys_mod_count": "0",
    "content_type": "image/jpeg",
    "size_compressed": "25130",
    "created_by_name": "John Smith",
    "updated_by_name": "John Smith"
  }
}