CSM 첨부 파일 API

CSM 첨부 파일 API는 내부 및 외부 사용자가 테이블과 연결된 첨부 파일을 업로드, 다운로드, 제거하고 첨부 파일 메타데이터를 검색할 수 있는 엔드포인트를 제공합니다.

시스템 속성에 glide.rest.attachment_csm_api.allowed_tables 지정된 테이블과 연결된 첨부 파일만 연결된 엔드포인트 호출에 유효합니다. 로그인한 모든 사용자(snc_internal 및 snc_external 모두 이 API에 액세스할 수 있습니다. 게스트 및 공용 사용자에게는 액세스 권한이 없습니다.

이 API는 업로드된 파일에 대한 시스템 제한 사항(예: 최대 파일 크기 및 허용되는 첨부 파일 유형)을 준수합니다. and glide.attachment.extensions 속성을 사용하여 com.glide.attachment.max_size 이러한 설정을 제어할 수 있습니다.

기본적으로 이 API에는 인증되지 않은 사용자와 snc_external 사용자에 대한 시간당 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}

지원되는 요청 매개변수

표 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_ 사용하여 참조할 수 있습니다. 예를 들어, for sysparm_limit 를 사용할 limit수도 있습니다.

URL 형식

버전이 지정된 URL: /api/now/{api_version}/attachment_csm

기본 URL: /api/now/v1/attachment_csm

지원되는 요청 매개변수

표 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>: 다음 값을 지원합니다. =: 정확히 <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) 인코딩된 쿼리는 기능별 순서도 지원합니다. 특정 필드를 기반으로 응답을 정렬하려면 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": { "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-shockwave-flash)입니다. 데이터 유형: 문자열
result.created_by_name	첨부 파일을 처음 생성한 엔터티의 전체 이름입니다. 데이터 유형: 문자열
result.download_link	인스턴스에 있는 첨부 파일의 URL을 다운로드합니다 ServiceNow . 데이터 유형: 문자열
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_업데이트_기준	첨부 파일을 마지막으로 업데이트한 엔터티입니다. 데이터 유형: 문자열
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

지원되는 요청 매개변수

표 13. 경로 매개변수

이름	설명
api_version	옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열
sys_id	첨부 파일 [sys_attachment] 테이블에 나열된 첨부 파일의 Sys_id입니다. 이 첨부 파일은 시스템 속성 [sys_properties] 테이블의 속성 내에 glide.rest.attachment_csm_api.allowed_tables 나열된 테이블 중 하나에 속해야 합니다.

표 14. 쿼리 매개변수

이름	설명
없음

표 15. 요청 본문 매개변수(XML 또는 JSON)

이름	설명
없음

헤더

다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.

표 16. 요청 헤더

헤더	설명
수용	응답 본문의 데이터 형식입니다. 예를 들어 image/jpeg 또는 image/png 를 사용하여 JPEG 또는 PNG 이미지 파일만 허용합니다. 모든 이미지 유형을 허용하려면 image/*를 지정합니다. 모든 파일 형식을 허용하려면 */*를 지정합니다. 기본값:*/*

표 17. 응답 헤더

헤더	설명
X-첨부 파일-메타데이터	반환된 파일에 대한 메타데이터(예: 크기, 이름 및 파일 형식)입니다.

상태 코드

다음 상태 코드는 이 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}

지원되는 요청 매개변수

표 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": { "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-shockwave-flash)입니다. 데이터 유형: 문자열
result.created_by_name	첨부 파일을 처음 생성한 엔터티의 전체 이름입니다. 데이터 유형: 문자열
result.download_link	인스턴스에 있는 첨부 파일의 URL을 다운로드합니다 ServiceNow . 데이터 유형: 문자열
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_업데이트_기준	첨부 파일을 마지막으로 업데이트한 엔터티입니다. 데이터 유형: 문자열
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

지원되는 요청 매개변수

표 25. 경로 매개변수

이름	설명
api_version	옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열

표 26. 쿼리 매개변수

이름	설명
encryption_context	암호화 컨텍스트 기록의 Sys_id입니다. 지정된 암호화 컨텍스트를 가진 사용자만 첨부 파일에 접근할 수 있도록 하려면 이 매개변수를 지정하십시오. 암호화 컨텍스트 기록에 대한 자세한 내용은 다음 문서를 참조하십시오 Column Level 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
컨텐츠-형식	필수 게시할 파일의 데이터 형식입니다. 예를 들어 image/jpeg 또는 image/png 를 사용하여 JPEG 또는 PNG 이미지 파일만 게시합니다. 모든 이미지 유형을 허용하려면 image/*를 지정합니다. 모든 파일 형식을 허용하려면 */*를 지정합니다.

표 29. 응답 헤더

헤더	설명
없음

상태 코드

다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

표 30. 상태 코드

상태 코드	설명
200	성공입니다. 요청이 성공적으로 처리되었습니다.
400	잘못된 요청입니다. 이 테이블의 첨부 파일에 접근할 수 없음을 나타냅니다. 연결된 테이블이 시스템 속성에 glide.rest.attachment_csm_api.allowed_tables 포함되어 있는지 확인합니다.
401	승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다.
404	찾을 수 없습니다. 및 table_sys_id 매개변수로 지정된 기록이 없거나 현재 사용자가 액세스할 수 없음을 table_name 나타냅니다.
500	내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다.

응답 본문 매개변수(JSON 또는 XML)

요소	설명
결과	요청된 첨부 파일의 메타데이터입니다. 데이터 유형: 객체 "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-shockwave-flash)입니다. 데이터 유형: 문자열
result.created_by_name	첨부 파일을 처음 생성한 엔터티의 전체 이름입니다. 데이터 유형: 문자열
result.download_link	인스턴스에 있는 첨부 파일의 URL을 다운로드합니다 ServiceNow . 데이터 유형: 문자열
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_업데이트_기준	첨부 파일을 마지막으로 업데이트한 엔터티입니다. 데이터 유형: 문자열
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

멀티파트 첨부 파일을 업로드합니다.

multipart POST 메서드는 매개 변수를 허용하지 않습니다. 테이블 이름을 지정하고 양식 본문 내에서 sys_id 값을 기록해야 합니다. multipart/form-data 요청 샘플은 아래의 cURL 예를 참조하세요.

주:

멀티파트 POST를 사용하는 경우 파일 내용이 메시지의 마지막 부분에만 포함되어 있는지 확인합니다. 이전 부분에는 테이블 이름 및 기록 sys_id와 같은 메타데이터만 포함되어야 했습니다.

첨부 파일을 업로드하기 위해 multipart/form-data POST 요청을 보낼 때 URL 매개 변수 또는 요청 본문이 아닌 양식 본문에 첨부 파일 데이터를 포함합니다.

표 31. 필수 값

값	설명
컨텐츠-형식	멀티파트 업로드를 위해 메시지 본문에 포함된 파일의 콘텐츠 유형입니다. 주: 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

지원되는 요청 매개변수

표 32. 경로 매개변수

이름	설명
api_version	옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열

표 33. 쿼리 매개변수

이름	설명
없음

표 34. 요청 본문 매개변수(XML 또는 JSON)

이름	설명
없음

헤더

다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.

표 35. 요청 헤더

헤더	설명
컨텐츠-형식	요청 본문의 데이터 형식입니다. multipart POST 메서드를 사용할 때 이 값을 multipart/form-data 로 설정합니다.

표 36. 응답 헤더

헤더	설명
위치	플랫폼 인스턴스에 있는 새 첨부 파일의 URL입니다 ServiceNow .

상태 코드

다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

표 37. 상태 코드

상태 코드	설명
201	성공입니다. 요청이 성공적으로 완료되었음을 나타냅니다.
400	잘못된 요청입니다. 이 테이블의 첨부 파일에 접근할 수 없음을 나타냅니다. 연결된 테이블이 시스템 속성에 glide.rest.attachment_csm_api.allowed_tables 포함되어 있는지 확인합니다.
401	승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다.
404	찾을 수 없습니다. 요청한 항목을 찾을 수 없습니다.
500	내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다.

응답 본문 매개변수(JSON 또는 XML)

요소	설명
결과	요청된 첨부 파일의 메타데이터입니다. 데이터 유형: 객체 "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-shockwave-flash)입니다. 데이터 유형: 문자열
result.created_by_name	첨부 파일을 처음 생성한 엔터티의 전체 이름입니다. 데이터 유형: 문자열
result.download_link	인스턴스에 있는 첨부 파일의 URL을 다운로드합니다 ServiceNow . 데이터 유형: 문자열
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_업데이트_기준	첨부 파일을 마지막으로 업데이트한 엔터티입니다. 데이터 유형: 문자열
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"
  }
}