CSM 添付ファイル 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 プロパティ内にリストされているテーブルのいずれかに属している必要があります。データタイプ：文字列

表 : 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値が異常に大きいと、システムのパフォーマンスに影響を与える可能性があります。データタイプ：数値デフォルト：10000
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>:次の値をサポートします。 =:<値>と完全に一致します。 !=:<値>と一致しません。 ^: 論理的に 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)` エンコードクエリは、順番の機能もサポートしています。特定のフィールドに基づいて応答をソートするには、sysparm_queryで `ORDERBY` 句と `ORDERBYDESC` 句を使用します。構文: `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	画像や jpeg、application/x-shockwave-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 プロパティ内にリストされているテーブルのいずれかに属している必要があります。データタイプ：文字列テーブル:添付ファイル [sys_attachment]

表 : 14. クエリパラメーター
名前	説明
なし

表 : 15. 要求本文パラメーター (XML または JSON)
名前	説明
なし

ヘッダー

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

表 : 16. 要求ヘッダー
ヘッダー	説明
承認	応答本文のデータフォーマット。たとえば、 `image/jpeg` または `image/png` を使用して、JPEG または 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 プロパティ内にリストされているテーブルのいずれかに属している必要があります。データタイプ：文字列

表 : 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	画像や jpeg、application/x-shockwave-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	画像や jpeg、application/x-shockwave-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 ディレクトリにIssue_screenshot.jpg.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	マルチパートアップロードのメッセージ本文に含まれるファイルのコンテンツタイプ。注: Content-Type は、フォームデータ内ではなく、POST メッセージのファイル部分内で定義する必要があります。データタイプ：文字列
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	要求本文のデータ形式。multipart 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	画像や jpeg、application/x-shockwave-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"
  }
}