--- sourceDocument: Xanadu API 참조 sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/ko-KR/xanadu/api-reference Release : - xanadu ft:locale : - ko-KR ft:publication_title : - Xanadu API 참조 ft:clusterId : - crapiref bundleId : - crapiref workflow : - Creator --- # 설치 기반 항목 API # 설치 기반 항목 API {#ariaid-title1} * 릴리스 버전: Xanadu * * 업데이트 날짜 2024년 08월 01일 * * ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 소요 시간: 253분 설치 기반 항목 API는 인스턴스 내의 설치 기반 항목 기록에 액세스하고 이를 관리할 수 있는 엔드포인트를 ServiceNow 제공합니다. 설치 기반 항목은 고객에 대해 구성된 제품의 인스턴스를 나타냅니다. 설치 기반 항목을 사용하면 고객의 모든 구매를 추적할 수 있습니다. 이 API를 사용하여 설치 기반 관련 당사자 관련 목록에서 CRUD 작업을 수행할 수도 있습니다. 또한 케이스, 계약, 권리, 유지관리 계획, 판매된 제품 및 작업 주문과 같은 다른 설치 기반 항목 관련 목록에서 기록을 읽을 수 있습니다. 이 API에 액세스하려면 수행하려는 CRUD 작업의 유형에 따라 sn_install_base.ib_api_write 또는 sn_install_base.ib_api_read 역할이 있어야 합니다. 이 API의 다양한 엔드포인트에 액세스하려면 다음 플러그인을 설치해야 합니다. * Customer Service Install Base Management (com.snc.install_base) * 계획된 작업 관리(sn_fsm_planned_wm) - 유지관리 계획 및 작업 주문 데이터를 검색하려는 경우. 이 API는 `sn_install_base` 네임스페이스에서 실행됩니다. 주: 이 API는 엔드포인트 응답에서 비어 있지 않은 필드만 반환합니다. 또한 sys_id 필드를 제외하고 시스템 수준 필드(앞에 "sys_"가 붙은 필드)는 반환되지 않습니다. 설치 기반 항목에 대한 자세한 내용은 을 참조하십시오 [Create an install base item](https://www.servicenow.com/docs/access?context=create-install-base-item&version=xanadu&pubname=xanadu-customer-service-management&ft:locale=en-US). ## 설치 기반 항목 - DELETE /sn_install_base/integrations/installbaseitems/{id}/relatedparties/{related_party_sys_id} {#ariaid-title2} 지정된 설치 기반 항목 기록에서 지정된 관련 당사자 기록의 연결을 해제합니다.
### URL 형식 버전이 지정된 URL: /api/sn_install_base/{api_version}/integrations/installbaseitems/{id}/relatedparties/{related_party_sys_id} 기본 URL: /api/sn_install_base/integrations/installbaseitems/{id}/relatedparties/{related_party_sys_id} ### 지원되는 요청 매개변수 {#integrat-DELETE-relatedparties__entry__2}{#integrat-DELETE-relatedparties__version-RESTAPI}{#integrat-DELETE-relatedparties__integrate-id-entry}{#integrat-DELETE-relatedparties__related_party_sys_id-integrate-entry} | 이름 | 설명 | |-|-| | api_version | 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열 | | id | 설치 기반 항목 기록의 Sys_id입니다. 설치 기반 항목 \[sn_install_base_item\] 테이블에 있습니다. 데이터 유형: 문자열 | | related_party_sys_id | 관련 당사자 기록의 Sys_id입니다. 기본적으로 설치 기반 관련 당사자\[sn_install_base_related_party\] 테이블에 있습니다. 데이터 유형: 문자열 | [표 1. 경로 매개변수] {#integrat-DELETE-relatedparties__entry__10} | 이름 | 설명 | |-|-| | 없음 | | [표 2. 쿼리 매개변수] {#integrat-DELETE-relatedparties__entry__14} | 이름 | 설명 | |-|-| | 없음 | | [표 3. 요청 본문 매개변수(XML 또는 JSON)] ### 헤더 다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 [지원되는 REST API 헤더를](https://servicenow-prod.fluidtopics.net/JHL64oGR2SkU25ZTkfHy7g "REST(REpresentational State Transfer)는 웹상의 컴퓨터 시스템 간에 표준을 제공하여 서로 보다 쉽게 통신할 수 있게 지원하는 단순한 상태 비저장 아키텍처입니다.") 참조하세요. {#integrat-DELETE-relatedparties__entry__18}{#integrat-DELETE-relatedparties__accept-RESTAPI} | 헤더 | 설명 | |-|-| | 수용 | 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json | [표 4. 요청 헤더] {#integrat-DELETE-relatedparties__entry__22} | 헤더 | 설명 | |-|-| | 없음 | | [표 5. 응답 헤더] ### 상태 코드 다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 [REST API HTTP 응답 코드를](https://servicenow-prod.fluidtopics.net/JHL64oGR2SkU25ZTkfHy7g "REST(REpresentational State Transfer)는 웹상의 컴퓨터 시스템 간에 표준을 제공하여 서로 보다 쉽게 통신할 수 있게 지원하는 단순한 상태 비저장 아키텍처입니다.") 참조하세요. {#integrat-DELETE-relatedparties__entry__26}{#integrat-DELETE-relatedparties__entry-200-status-code}{#integrat-DELETE-relatedparties__entry-403-status-code}{#integrat-DELETE-relatedparties__entry-404-status-code}{#integrat-DELETE-relatedparties__entry-500-status-code} | 상태 코드 | 설명 | |-|-| | 200 | 성공입니다. 요청이 성공적으로 처리되었습니다. | | 403 | 금지되었습니다. 사용자에게 지정된 기록에 대한 액세스 권한이 없습니다. | | 404 | 찾을 수 없습니다. 요청한 항목을 찾을 수 없습니다. | | 500 | 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다. | [표 6. 상태 코드] ### 응답 본문 매개변수(JSON 또는 XML) {#integrat-DELETE-relatedparties__id_zk1_w5w_ywb__entry__2}{#integrat-DELETE-relatedparties__error-integration-entry}{#integrat-DELETE-relatedparties__error_detail-integration-entry}{#integrat-DELETE-relatedparties__error_message-integration-entry}{#integrat-DELETE-relatedparties__result-integration-entry} | 이름 | 설명 | |-|-| | 오류 | 요청을 처리하려고 할 때 발생한 오류에 대한 상세 정보입니다. 데이터 유형: 객체 "error": { "detail": "String", "message": "String" } | | 오류.상세 정보 | 관련 오류에 대한 추가 정보입니다. 데이터 유형: 문자열 | | 오류.메시지 | 요청을 실행하려고 할 때 발생한 문제를 설명하는 오류 메시지입니다. 데이터 유형: 문자열 | | 결과 | 엔드포인트 결과에 대한 설명입니다. 데이터 유형: 객체 | | 결과.상태 | 엔드포인트 요청의 상태입니다. 가능한 값: * 성공 * 실패 데이터 유형: 문자열 | [ ] {#integrat-DELETE-relatedparties__id_zk1_w5w_ywb} ### cURL 요청 다음 코드 예제에서는 이 끝점을 호출하는 방법을 보여 줍니다. curl "https://instance.servicenow.com/api/sn_install_base/integrations/installbaseitems/f77c7542b7343300ece839a6ee11a991/relatedparties/2a42dfae872521100b6afc86dabb356b" \ --request DELETE \ --header "Accept:application/json" \ --user 'username':'password' 반환 결과: { "result": { "status": "SUCCESS" } } ## 설치 기반 항목 - GET /sn_install_base/integrations/installbaseitems {#ariaid-title3} 모든 설치 기반 항목을 반환합니다. 호출 내에서 매개 변수를 전달하여 반환 결과를 필터링할 수 있습니다. ### URL 형식 버전이 지정된 URL: /api/sn_install_base/{api_version}/integrations/installbaseitems 기본 URL: /api/sn_install_base/integrations/installbaseitems ### 지원되는 요청 매개변수 {#integrat-GET-installbaseitems__entry__2}{#integrat-GET-installbaseitems__version-RESTAPI} | 이름 | 설명 | |-|-| | api_version | 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열 | [표 7. 경로 매개변수] {#integrat-GET-installbaseitems__entry__6}{#integrat-GET-installbaseitems__sysparm-limit-RESTAPI}{#integrat-GET-installbaseitems__sysparm_offset-ph-RESTAPI} | 이름 | 설명 | |-|-| | 필드 이름-값 쌍 | 설치 기반 항목 기록을 필터링하는 데 사용할 필드-값 쌍입니다. 설치 기반 항목 \[sn_istall_base_item\] 테이블에 있습니다. 에서 sys_class_name다른 테이블을 지정하는 경우 해당 테이블의 필드를 지정합니다. 하나 이상의 필드-값 쌍을 전달하여 반환 결과를 필터링할 수 있습니다. 예를 들어 상태 필드가 "in_use"로 설정되고 상태 필드가 "교체"로 설정된 기록만 반환하려면 `&state=in_use&status=replacement`를 전달합니다. 데이터 유형: 문자열 기본값: 모든 필드 | | related_party | 관련 당사자 기록의 Sys_id입니다. 설치 기반 관련 당사자\[sn_install_base_related_party\] 테이블에 있습니다. 지정된 관련 당사자를 기준으로 설치 기반 항목 기록을 필터링합니다. 관련 당사자는 설치 기반 항목 또는 판매된 제품에 연결할 수 있습니다. 유효한 값은 다음과 같습니다. * 계정 sys_id - 계정 \[customer_account\] 테이블에 있습니다. * 소비자 sys_id - 소비자 \[csm_consumer\] 테이블에 있습니다. * 연락처 sys_id - 연락처 \[customer-contact\] 테이블에 있습니다. * 서비스 조직 sys_id - 서비스 조직 \[sn_customer_service_organization\] 테이블에 있습니다. * 사용자 sys_id - 사용자 \[sys-user\] 테이블에 있습니다. 데이터 유형: 문자열 | | 책임 | 연결된 책임 기록의 Sys_id입니다. 이 기록은 설치 기반 정보에 대한 액세스 수준을 정의합니다. 이 매개변수는 필드도 related_party 지정된 경우에만 유효합니다. 지정한 경우 및 responsibility 매개변수 모두 related_party 와 일치하는 설치 기반 항목만 반환합니다. 자세한 내용은 [Configure related parties for items received](https://www.servicenow.com/docs/access?context=psds-add-related-parties-to-record&version=xanadu&pubname=xanadu-government-industry&ft:locale=en-US) 문서를 참조하십시오. 데이터 유형: 문자열 | | sys_class_name | 원하는 기록이 설치 기반 항목 \[sn_install_base_item\] 테이블을 확장하는 테이블에 있는 경우 쿼리할 확장된 테이블의 이름입니다. 데이터 유형: 문자열 | | sysparm_limit | 반환할 최대 기록 수입니다. 이 기록 수를 초과하는 요청의 경우 sysparm_offset 매개변수를 사용하여 기록 검색을 페이지 매김합니다. 이 제한은 ACL 평가 전에 적용됩니다. 액세스할 수 있는 기록을 포함하여 반환되는 기록이 없으면 액세스할 수 있는 기록이 먼저 반환되도록 기록 순서를 다시 정렬합니다. 주: 이례적으로 큰 sysparm_limit 값은 시스템 성능에 영향을 미칠 수 있습니다. 데이터 유형: 숫자 기본값: 10000 | | sysparm_offset | 기록 검색을 시작할 시작 기록 인덱스입니다. 이 값을 사용하여 기록 검색을 페이지 매김합니다. 이 기능을 사용하면 기록 수와 관계없이 관리 가능한 작은 청크로 모든 기록을 검색할 수 있습니다. 예를 들어 이 엔드포인트를 처음 호출할 때 sysparm_offset이 "0"으로 설정됩니다. 사용 가능한 모든 기록을 간단히 살펴보려면 모든 기록이 끝날 때까지 `sysparm_offset=sysparm_offset+sysparm_limit`를 사용합니다.{#integrat-GET-installbaseitems__sysparm_offset-p-RESTAPI} 매개 변수에 sysparm_offset 음수를 전달하지 마세요. 데이터 유형: 숫자 기본값: 0 | [표 8. 쿼리 매개변수] {#integrat-GET-installbaseitems__entry__20} | 이름 | 설명 | |-|-| | 없음 | | [표 9. 요청 본문 매개변수(XML 또는 JSON)] ### 헤더 다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 [지원되는 REST API 헤더를](https://servicenow-prod.fluidtopics.net/JHL64oGR2SkU25ZTkfHy7g "REST(REpresentational State Transfer)는 웹상의 컴퓨터 시스템 간에 표준을 제공하여 서로 보다 쉽게 통신할 수 있게 지원하는 단순한 상태 비저장 아키텍처입니다.") 참조하세요. {#integrat-GET-installbaseitems__entry__24}{#integrat-GET-installbaseitems__accept-RESTAPI} | 헤더 | 설명 | |-|-| | 수용 | 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json | [표 10. 요청 헤더] {#integrat-GET-installbaseitems__entry__28} | 헤더 | 설명 | |-|-| | 없음 | | [표 11. 응답 헤더] ### 상태 코드 다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 [REST API HTTP 응답 코드를](https://servicenow-prod.fluidtopics.net/JHL64oGR2SkU25ZTkfHy7g "REST(REpresentational State Transfer)는 웹상의 컴퓨터 시스템 간에 표준을 제공하여 서로 보다 쉽게 통신할 수 있게 지원하는 단순한 상태 비저장 아키텍처입니다.") 참조하세요. {#integrat-GET-installbaseitems__entry__32}{#integrat-GET-installbaseitems__entry-200-status-code}{#integrat-GET-installbaseitems__entry-400-status-code}{#integrat-GET-installbaseitems__entry-403-status-code}{#integrat-GET-installbaseitems__entry-500-status-code} | 상태 코드 | 설명 | |-|-| | 200 | 성공입니다. 요청이 성공적으로 처리되었습니다. | | 400 | 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다. | | 403 | 금지되었습니다. 사용자에게 지정된 기록에 대한 액세스 권한이 없습니다. | | 500 | 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다. | [표 12. 상태 코드] ### 응답 본문 매개변수(JSON 또는 XML) 다음 반환 결과는 설치 기반 항목 \[sn_install_base_items\] 테이블에서 반환된 레코드의 반환 값만 설명합니다. {#integrat-GET-installbaseitems__id_qgj_jg2_zwb__entry__2}{#integrat-GET-installbaseitems__has_more-integration-entry}{#integrat-GET-installbaseitems__account-integration-entry}{#integrat-GET-installbaseitems__account_display_value-integration-entry}{#integrat-GET-installbaseitems__account_sys_id-integration-entry}{#integrat-GET-installbaseitems__active-integration-entry}{#integrat-GET-installbaseitems__asset-integration-entry}{#integrat-GET-installbaseitems__asset_display_value-integration-entry}{#integrat-GET-installbaseitems__asset_sys_id-integration-entry}{#integrat-GET-installbaseitems__configuration_item-integration-entry}{#integrat-GET-installbaseitems__configuration_item_display_value-integration-entry}{#integrat-GET-installbaseitems__configuration_item_sys_id-integration-entry}{#integrat-GET-installbaseitems__consumer-integration-entry}{#integrat-GET-installbaseitems__consumer_display_value-integration-entry}{#integrat-GET-installbaseitems__consumer_sys_id-integration-entry}{#integrat-GET-installbaseitems__consumer_profile-integration-entry}{#integrat-GET-installbaseitems__consumer_profile_display_value-integration-entry}{#integrat-GET-installbaseitems__consumer_profile_sys_id-integration-entry}{#integrat-GET-installbaseitems__contact-integration-entry}{#integrat-GET-installbaseitems__contact_display_value-integration-entry}{#integrat-GET-installbaseitems__contact_sys_id-integration-entry}{#integrat-GET-installbaseitems__health_status-integration-entry}{#integrat-GET-installbaseitems__health_status_display_value-integration-entry}{#integrat-GET-installbaseitems__health_status_value-integration-entry}{#integrat-GET-installbaseitems__health_status_last_updated-integration-entry}{#integrat-GET-installbaseitems__household-integration-entry}{#integrat-GET-installbaseitems__household_display_value-integration-entry}{#integrat-GET-installbaseitems__household_sys_id-integration-entry}{#integrat-GET-installbaseitems__install_date-integration-entry}{#integrat-GET-installbaseitems__install_date_display_value-integration-entry}{#integrat-GET-installbaseitems__install_date_value-integration-entry}{#integrat-GET-installbaseitems__location-integration-entry}{#integrat-GET-installbaseitems__location_display_value-integration-entry}{#integrat-GET-installbaseitems__location_sys_id-integration-entry}{#integrat-GET-installbaseitems__name-integration-entry}{#integrat-GET-installbaseitems__number-integration-entry}{#integrat-GET-installbaseitems__parent-integration-entry}{#integrat-GET-installbaseitems__parent_display_value-integration-entry}{#integrat-GET-installbaseitems__parent_sys_id-integration-entry}{#integrat-GET-installbaseitems__product-integration-entry}{#integrat-GET-installbaseitems__product_display_value-integration-entry}{#integrat-GET-installbaseitems__product_sys_id-integration-entry}{#integrat-GET-installbaseitems__service_context-integration-entry}{#integrat-GET-installbaseitems__service_context_display_value-integration-entry}{#integrat-GET-installbaseitems__service_context_sys_id-integration-entry}{#integrat-GET-installbaseitems__service_organization-integration-entry}{#integrat-GET-installbaseitems__service_organization_display_value-integration-entry}{#integrat-GET-installbaseitems__service_organization_sys_id-integration-entry}{#integrat-GET-installbaseitems__sys_class_name-integration-entry}{#integrat-GET-installbaseitems__sys_id-integration-entry}{#integrat-GET-installbaseitems__sys_mod_count-integration-entry}{#integrat-GET-installbaseitems__state-integration-entry}{#integrat-GET-installbaseitems__state_display_value-integration-entry}{#integrat-GET-installbaseitems__state_value-integration-entry}{#integrat-GET-installbaseitems__status1-integration-entry}{#integrat-GET-installbaseitems__status1_display_value-integration-entry}{#integrat-GET-installbaseitems__status1_value-integration-entry}{#integrat-GET-installbaseitems__uninstall_date-integration-entry}{#integrat-GET-installbaseitems__uninstall_date_display_value-integration-entry}{#integrat-GET-installbaseitems__uninstall_date_value-integration-entry}{#integrat-GET-installbaseitems__status-integration-entry}{#integrat-GET-installbaseitems__sysparm_depth-integration-entry}{#integrat-GET-installbaseitems__sysparm_limit-integration-entry}{#integrat-GET-installbaseitems__sysparm_offset-integration-entry} | 이름 | 설명 | |-|-| | 오류 | 요청을 처리하려고 할 때 발생한 오류에 대한 상세 정보입니다. 데이터 유형: 객체 "error": { "detail": "String", "message": "String" } | | 오류.상세 정보 | 관련 오류에 대한 추가 정보입니다. 데이터 유형: 문자열 | | 오류.메시지 | 요청을 실행하려고 할 때 발생한 문제를 설명하는 오류 메시지입니다. 데이터 유형: 문자열 | | has_more | 테이블에 반환할 기록이 더 있는지 여부를 나타내는 플래그입니다. 가능한 값: * true: 반환할 레코드가 더 많습니다. * false: 더 이상 반환할 기록이 없습니다. 데이터 형식: 부울 문자열 | | 항목 | 지정된 필터 결과와 일치하는 설치 기반 항목의 목록입니다. 데이터 형식: 객체 배열 "items":[ { "account": {Object}, "active": "String", "asset": {Object}, "configuration_item": {Object}, "consumer": {Object}, "consumer_profile": {Object}, "contact": {Object}, "health_status": {Object}, "health_status_last_updated": "String", "household": {Object}, "install_date": {Object}, "location": {Object}, "name": "String", "number": "String", "parent": {Object}, "product": {Object}, "service_context": {Object}, "service_organization" {Object}, "sys_class_name": "String", "sys_id": "String", "sys_mod_count": "String", "state": {Object}, "status": {Object}, "uninstall_date": "String" } ] | | items.account | 설치 기반 항목 기록과 연결된 고객 계정에 대한 세부 정보입니다. 데이터 유형: 객체 "account": { "display_value": "String", "sys_id": "String" } | | items.account.display_value | 설치 기반 항목 기록과 연결된 고객 계정의 텍스트 이름입니다. 이 값을 사용하여 UI에 고객 계정 이름을 표시합니다. 데이터 유형: 문자열 | | items.account.sys_id | 설치 기반 항목 기록과 연결된 고객 계정 기록의 Sys_id입니다. 데이터 유형: 문자열 | | items.active | 설치 기반 항목이 활성 상태인지 여부를 나타내는 플래그입니다. 가능한 값: * true: 설치 기반 항목이 활성 상태입니다. * false: 설치 기반 항목이 비활성 상태입니다. 데이터 유형: 부울 문자열 | | items.asset | 설치 기반 항목 기록과 연결된 자산에 대한 세부 정보입니다. 데이터 유형: 객체 "asset": { "display_value": "String", "sys_id": "String" } | | items.asset.display_value | 설치 기반 항목 기록과 연결된 자산의 텍스트 이름입니다. 이 값을 사용하여 UI에 자산 이름을 표시합니다. 데이터 유형: 문자열 | | items.asset.sys_id | 설치 기반 항목 기록과 연결된 자산 기록의 Sys_id입니다. 데이터 유형: 문자열 | | items.configuration_item | 설치 기반 항목 기록과 연결된 구성 항목에 대한 세부 정보입니다. 데이터 유형: 객체 "configuration_item": { "display_value": "String", "sys_id": "String" } | | items.configuration_item.display_value | 설치 기반 항목 기록과 연결된 구성 항목의 텍스트 이름입니다. 이 값을 사용하여 UI에 구성 항목 이름을 표시합니다. 데이터 유형: 문자열 | | items.configuration_item.sys_id | 설치 기반 항목 기록과 연결된 구성 항목 기록의 Sys_id입니다. 데이터 유형: 문자열 | | items.consumer | 설치 기반 항목 기록과 연결된 소비자에 대한 세부 정보입니다. 주: 소비자 필드는 B2B2C 플러그인이 설치된 경우에만 사용할 수 있습니다. 데이터 유형: 객체 "consumer": { "display_value": "String", "sys_id": "String" } | | items.consumer.display_value | 설치 기반 항목 기록과 연결된 소비자의 텍스트 이름입니다. 이 값을 사용하여 UI에 소비자 이름을 표시합니다. 데이터 유형: 문자열 | | items.consumer.sys_id | 설치 기반 항목 기록과 연결된 소비자 기록의 Sys_id입니다. 데이터 유형: 문자열 | | items.consumer_profile | 설치 기반 항목 기록과 연결된 소비자 프로필에 대한 세부 정보입니다. 주: 소비자 프로필 필드는 B2B2C 플러그인이 설치된 경우에만 사용할 수 있습니다. 데이터 유형: 객체 "consumer_profile": { "display_value": "String", "sys_id": "String" } | | items.consumer_profile.display_value | 설치 기반 항목 기록과 연결된 소비자 프로필의 텍스트 이름입니다. 이 값을 사용하여 UI에 소비자 프로파일 이름을 표시합니다. 데이터 유형: 문자열 | | items.consumer_profile.sys_id | 설치 기반 항목 기록과 연결된 소비자 프로필 기록의 Sys_id입니다. 데이터 유형: 문자열 | | items.contact | 설치 기반 항목 기록을 담당하는 계정 접촉 창구에 대한 세부 정보입니다. 데이터 유형: 객체 "contact": { "display_value": "String", "sys_id": "String" } | | items.contact.display_value | 설치 기반 항목 기록과 연결된 계정 연락처의 텍스트 이름입니다. 이 값을 사용하여 UI에 계정 접촉 창구 이름을 표시합니다. 데이터 유형: 문자열 | | items.contact.sys_id | 설치 기반 항목 기록과 연결된 계정 연락처 기록의 Sys_id입니다. 데이터 유형: 문자열 | | items.health_status | 설치 기반 항목의 현재 상태에 대한 세부 정보입니다. com.snc.proactive_cs_itom(사전 예방적 고객 서비스 운영) 플러그인이 설치된 경우에만 반환됩니다. 데이터 유형: 객체 "health_status": { "display_value": "String", "value": "String" } | | items.health_status.display_value | 설치 기반 항목의 현재 상태를 나타내는 텍스트 문자열입니다. 이 값을 사용하여 UI에 상태를 표시합니다. 데이터 유형: 문자열 | | items.health_status.value | 설치 기반 항목의 상태에 대한 내부 값입니다. 데이터 유형: 문자열 | | items.health_status_last_updated | 설치 기반 항목의 상태가 마지막으로 업데이트된 날짜 및 시간입니다. 데이터 유형: 문자열 | | items.household | 설치 기반 항목 기록과 연결된 세대에 대한 세부 정보입니다. Customer Service Household(com.snc.household) 플러그인이 설치된 경우에만 반환됩니다. 데이터 유형: 객체 "household": { "display_value": "String", "sys_id": "String" } | | items.household.display_value | 설치 기반 항목 기록과 연결된 세대의 텍스트 이름입니다. 이 값을 사용하여 UI에 세대 이름을 표시합니다. 데이터 유형: 문자열 | | items.household.sys_id | 설치 기반 항목 기록과 연결된 세대 Sys_id입니다. 데이터 유형: 문자열 | | items.install_date | 설치 기반 항목이 활성화된 날짜에 대한 세부 정보입니다. 데이터 유형: 객체 "install_date": { "display_value": "String", "value": "String" } | | items.install_date.display_value | 텍스트 설치 날짜입니다. 이 값을 사용하여 UI에 설치 날짜를 표시합니다. 데이터 유형: 문자열 | | items.install_date.value | 설치 날짜의 내부 값입니다. 데이터 유형: 문자열 | | items.location | 설치 기반 항목의 위치에 대한 세부 정보입니다. 데이터 유형: 객체 "location": { "display_value": "String", "sys_id": "String" } | | items.location.display_value | 설치 기반 항목 위치의 텍스트 이름입니다. 이 값을 사용하여 UI에 위치 이름을 표시합니다. 데이터 유형: 문자열 | | items.location.sys_id | 설치 기반 항목 기록과 연결된 위치 기록의 Sys_id입니다. 데이터 유형: 문자열 | | items.name | 설치 기반 항목의 이름입니다. 데이터 유형: 문자열 | | items.number | 설치 기반 항목의 고유 ID입니다. 데이터 유형: 문자열 | | items.parent | 설치 기반 항목 기록의 상위 기록에 대한 세부 정보입니다. 데이터 유형: 객체 "parent": { "display_value": "String", "sys_id": "String" } | | items.parent.display_value | 설치 기반 항목 기록과 연결된 상위 기록의 텍스트 이름입니다. 이 값을 사용하여 UI에 상위 이름을 표시합니다. 데이터 유형: 문자열 | | items.parent.sys_id | 설치 기반 항목 기록과 연결된 상위 기록의 Sys_id입니다. 데이터 유형: 문자열 | | items.product | 설치 기반 항목 기록과 연결된 제품 모델에 대한 세부 정보입니다. 이 정보를 사용하여 제품 모델과 연결된 서비스를 식별합니다. 데이터 유형: 객체 "product": { "display_value": "String", "sys_id": "String" } | | items.product.display_value | 설치 기반 항목 기록과 연결된 제품 모델의 텍스트 이름입니다. 이 값을 사용하여 UI에 제품 이름을 표시합니다. 데이터 유형: 문자열 | | items.product.sys_id | 설치 기반 항목 기록과 연결된 제품 모델 기록의 Sys_id입니다. 데이터 유형: 문자열 | | items.service_context | 설치 기반 항목 기록과 연결된 서비스 컨텍스트에 대한 상세 정보입니다. 데이터 유형: 객체 "service_context": { "display_value": "String", "sys_id": "String" } | | items.service_context.display_value | 설치 기반 항목 기록과 연결된 서비스 컨텍스트의 텍스트 이름입니다. 이 값을 사용하여 UI에 서비스 컨텍스트 이름을 표시합니다. 데이터 유형: 문자열 | | items.service_context.sys_id | 설치 기반 항목 기록과 연결된 서비스 컨텍스트 기록의 Sys_id입니다. 데이터 유형: 문자열 | | items.service_organization | 설치 기반 항목 기록과 연결된 서비스 조직에 대한 세부 정보입니다. Service Organization(com.snc.service_organization) 플러그인이 설치된 경우에만 반환됩니다. 데이터 유형: 객체 "service_organization": { "display_value": "String", "sys_id": "String" } | | items.service_organization.display_value | 설치 기반 항목 기록과 연결된 서비스 조직의 텍스트 이름입니다. 이 값을 사용하여 UI에 서비스 조직 이름을 표시합니다. 데이터 유형: 문자열 | | items.service_organization.sys_id | 설치 기반 항목 기록과 연결된 서비스 조직 기록의 Sys_id입니다. 데이터 유형: 문자열 | | items.sys_클래스_이름 | 설치 기반 항목 기록을 포함하는 테이블입니다. 데이터 유형: 문자열 | | items.sys_id | 설치 기반 항목 기록의 Sys_id입니다. 매개변수에 지정된 sys_class_name 테이블에 있습니다. 데이터 유형: 문자열 | | items.sys_mod_count | 연결된 설치 기반 항목 기록이 수정된 횟수입니다. 데이터 유형: 문자열 | | items.state | 설치 기반 항목의 현재 상태에 대한 세부 정보입니다. 데이터 유형: 객체 "state": { "display_value": "String", "value": "String" } | | items.state.display_value | 설치 기반 항목의 현재 상태에 대한 텍스트 문자열입니다. 이 값을 사용하여 UI에 상태를 표시합니다. 데이터 유형: 문자열 | | items.state.value | 설치 기반 항목의 상태에 대한 내부 값입니다. 데이터 유형: 문자열 | | items.status | 설치 기반 항목의 상태에 대한 세부 정보입니다. 데이터 유형: 객체 "status": { "display_value": "String", "value": "String" } | | items.status.display_value | 설치 기반 항목의 상태에 대한 텍스트 문자열입니다. 이 값을 사용하여 UI에 상태를 표시합니다. 데이터 유형: 문자열 | | items.status.value | 설치 기반 항목의 상태에 대한 내부 값입니다. 데이터 유형: 문자열 | | items.uninstall_date | 설치 기반 항목이 비활성 상태가 된 날짜에 대한 세부 정보입니다. 데이터 유형: 객체 "uninstall_date": { "display_value": "String", "value": "String" } | | items.uninstall_date.display_value | 텍스트 제거 날짜. 이 값을 사용하여 UI에 제거 날짜를 표시합니다. 데이터 유형: 문자열 | | items.uninstall_date.값 | 제거 날짜의 내부 값입니다. 데이터 유형: 문자열 | | 상태 | 엔드포인트 호출의 상태입니다. 데이터 유형: 문자열 | | sysparm_depth | 계층 구조에서 반환되는 하위 설치 기반 항목의 수준 깊이의 수입니다. 데이터 형식: 정수 | | sysparm_limit | 반환된 기록 수입니다. 이 값이 원래 요청에 지정되지 않은 경우 기본값이 사용됩니다. 데이터 유형: 숫자 | | sysparm_offset | 기록이 평가 및 검색된 관련 테이블의 오프셋(시작 지점)입니다. 데이터 유형: 문자열 | [ ] {#integrat-GET-installbaseitems__id_qgj_jg2_zwb} ### cURL 요청 다음 코드 예제에서는 오프셋 5에서 시작하는 단일 레코드만 반환하는 간단한 호출을 보여 줍니다. curl "https://instance.servicenow.com/api/sn_install_base/v1/integrations/installbaseitems?sysparm_limit=1&sysparm_offset=5" \ --request GET \ --header "Accept:application/json" \ --user 'username':'password' 반환 결과: { "result": { "sysparm_offset": "5", "sysparm_limit": 1, "has_more": true, "items": [ { "sys_class_name": "sn_install_base_item", "number": "IBITM001100", "sys_id": "181df7ff530a1110539dddeeff7b12f4", "state": { "value": "in_use", "display_value": "In Use" }, "sys_mod_count": "2", "active": "true", "configuration_item": { "sys_id": "62446ae8535e5510539dddeeff7b12db", "display_value": "boxeoproderp" }, "name": "boxeoproderp", "account": { "sys_id": "86837a386f0331003b3c498f5d3ee4ca", "display_value": "Boxeo" } } ], "status": "SUCCESS" } } ### cURL 요청 {#integrat-GET-installbaseitems__example_rfd_jc4_1xb} 다음 코드 예제에서는 설치 기반 항목 테이블 내에서 = "in_use" 및 status = "교체" 필드를 state 검색하는 방법을 보여 줍니다. curl "https://instance.servicenow.com/api/sn_install_base/integrations/installbaseitems?state=in_use&status=replacement" \ --request GET \ --header "Accept:application/json" \ --user 'username':'password' 반환 결과: { "result": { "sysparm_offset": "0", "sysparm_limit": "10", "has_more": false, "items": [ { "parent": { "sys_id": "ffd023f453de9910539dddeeff7b1264", "display_value": "Point of Sale System" }, "sys_class_name": "sn_install_base_item", "number": "IBITM001140", "sys_id": "a1a123745312d910539dddeeff7b127b", "state": { "value": "in_use", "display_value": "In Use" }, "install_date": { "value": "2018-12-14 07:00:00", "display_value": "2018-12-13 23:00:00" }, "product": { "sys_id": "2dd1e7b753421110539dddeeff7b12d1", "display_value": "Stand" }, "active": "true", "name": "Stand", "service_organization": { "sys_id": "42b51f5ab3401010700b4d43c6a8dc5a", "display_value": "LA City Center - West" }, "status": { "value": "replacement", "display_value": "Replacement" } }, { "parent": { "sys_id": "ffd023f453de9910539dddeeff7b1264", "display_value": "Point of Sale System" }, "sys_class_name": "sn_install_base_item", "number": "IBITM001139", "sys_id": "d0916bb05312d910539dddeeff7b1232", "state": { "value": "in_use", "display_value": "In Use" }, "install_date": { "value": "2018-12-14 07:00:00", "display_value": "2018-12-13 23:00:00" }, "product": { "sys_id": "dfc127b753421110539dddeeff7b12ac", "display_value": "Register" }, "active": "true", "name": "Register", "service_organization": { "sys_id": "42b51f5ab3401010700b4d43c6a8dc5a", "display_value": "LA City Center - West" }, "status": { "value": "replacement", "display_value": "Replacement" } }, { "parent": { "sys_id": "ffd023f453de9910539dddeeff7b1264", "display_value": "Point of Sale System" }, "sys_class_name": "sn_install_base_item", "number": "IBITM001141", "sys_id": "ffb123745312d910539dddeeff7b12cb", "state": { "value": "in_use", "display_value": "In Use" }, "install_date": { "value": "2018-12-14 07:00:00", "display_value": "2018-12-13 23:00:00" }, "product": { "sys_id": "59e1e7b753421110539dddeeff7b12cc", "display_value": "Terminal" }, "active": "true", "name": "Terminal", "service_organization": { "sys_id": "42b51f5ab3401010700b4d43c6a8dc5a", "display_value": "LA City Center - West" }, "status": { "value": "replacement", "display_value": "Replacement" } } ], "status": "SUCCESS" } } ### cURL 요청 {#integrat-GET-installbaseitems__example_zwr_sg4_1xb} 다음 코드 예제에서는 및 responsibility 쿼리 매개 변수를 사용하여 related_party 반환 결과를 필터링하는 방법을 보여 줍니다. curl "https://instance.servicenow.com/api/sn_install_base/integrations/installbaseitems?related_party=dc0185d94f341200025ba3618110c77c&responsibility=c009bbedb3730010700b4d43c6a8dce" \ --request GET \ --header "Accept:application/json" \ --user 'username':'password' 반환 결과: { "result": { "sysparm_offset": "0", "sysparm_limit": "10", "has_more": false, "items": [ { "sys_class_name": "sn_install_base_item", "number": "IBITM0001004", "sys_id": "3ea014a778de1110f877d304c76fdd0d", "state": { "value": "in_use", "display_value": "In Use" }, "consumer": { "sys_id": "feb5139ab3401010700b4d43c6a8dc43", "display_value": "Kenny Smith" }, "product": { "sys_id": "63c8bc9778921110f877d304c76fdd34", "display_value": "X4 Sport Utility 4D" }, "active": "true", "name": "X4 Sport Utility 4D", "status": { "value": "original", "display_value": "Original" } }, { "sys_class_name": "sn_install_base_item", "number": "IBITM001003", "sys_id": "6e94e3c853500010df5dddeeff7b1234", "contact": { "sys_id": "4d147a386f0331003b3c498f5d3ee437", "display_value": "Julie Lewis" }, "active": "true", "configuration_item": { "sys_id": "a96a570453500010df5dddeeff7b1206", "display_value": "boxeosandbox" }, "name": "Boxeo - Sandbox", "account": { "sys_id": "86837a386f0331003b3c498f5d3ee4ca", "display_value": "Boxeo" } }, { "sys_class_name": "sn_install_base_item", "number": "IBITM0001010", "sys_id": "83332fde87e5a1105d0055373cbb3567", "contact": { "sys_id": "ddce70866f9331003b3c498f5d3ee417", "display_value": "George Warren" }, "state": { "value": "in_use", "display_value": "In Use" }, "install_date": { "value": "2023-02-26 18:59:52", "display_value": "2023-02-26 10:59:52" }, "health_status": { "value": "not_available", "display_value": "Not Available" }, "product": { "sys_id": "a9a2d0c3c6112276010db16c5ddd3461", "display_value": "Lenovo ThinkStation S20" }, "active": "true", "configuration_item": { "sys_id": "affd3c8437201000deeabfc8bcbe5dc3", "display_value": "*BETH-IBM" }, "name": "IB B2B", "location": { "sys_id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c", "display_value": "100 South Charles Street, Baltimore,MD" }, "asset": { "sys_id": "bfc1fa8837f3100044e0bfc8bcbe5ddf", "display_value": "P1000228 - Lenovo ThinkStation S20" }, "account": { "sys_id": "86837a386f0331003b3c498f5d3ee4ca", "display_value": "Boxeo" }, "status": { "value": "original", "display_value": "Original" } }, { "sys_class_name": "sn_install_base_item", "number": "IBITM0001011", "sys_id": "9d766f168729a1105d0055373cbb3597", "health_status": { "value": "not_available", "display_value": "Not Available" }, "product": { "sys_id": "8583ce8237732000158bbfc8bcbe5dd9", "display_value": "Fujitsu 1TB Hybrid Solid State Drive" }, "active": "true", "name": "IBA", "account": { "sys_id": "86837a386f0331003b3c498f5d3ee4ca", "display_value": "Boxeo" } }, { "sys_class_name": "sn_install_base_item", "number": "IBITM0001013", "sys_id": "bd955a2687ada1100b6afc86dabb35fb", "health_status": { "value": "not_available", "display_value": "Not Available" }, "consumer": { "sys_id": "59e788fbdb1b1200b6075200cf9619d2", "display_value": "Gilly Parker" }, "product": { "sys_id": "1a13974053500010df5dddeeff7b122c", "display_value": "12000XHD Digital Press" }, "active": "true", "name": "IBConsumer" }, { "sys_class_name": "sn_install_base_item", "number": "IBITM0000901", "sys_id": "f77c7542b7343300ece839a6ee11a991", "product": { "sys_id": "8583ce8237732000158bbfc8bcbe5dd9", "display_value": "Fujitsu 1TB Hybrid Solid State Drive" }, "active": "true", "name": "KX Series - KX5001", "account": { "sys_id": "86837a386f0331003b3c498f5d3ee4ca", "display_value": "Boxeo" } } ], "status": "SUCCESS" } } ## 설치 기반 항목 - GET /sn_install_base/integrations/installbaseitem/{id} {#ariaid-title4} 지정된 설치 기반 항목 기록과 해당 하위 계층 구조를 반환합니다.
### URL 형식 버전이 지정된 URL: /api/sn_install_base/{api_version}/integrations/installbaseitem/{id} 기본 URL: /api/sn_install_base/integrations/installbaseitem/{id} ### 지원되는 요청 매개변수 {#integrat-GET-installbaseitems-id__entry__2}{#integrat-GET-installbaseitems-id__version-RESTAPI}{#integrat-GET-installbaseitems-id__integrate-id-entry} | 이름 | 설명 | |-|-| | api_version | 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열 | | id | 설치 기반 항목 기록의 Sys_id입니다. 설치 기반 항목 \[sn_install_base_item\] 테이블에 있습니다. 데이터 유형: 문자열 | [표 13. 경로 매개변수] {#integrat-GET-installbaseitems-id__entry__8} | 이름 | 설명 | |-|-| | sys_class_name | 원하는 기록이 설치 기반 항목 \[sn_install_base_item\] 테이블을 확장하는 테이블에 있는 경우 쿼리할 확장된 테이블의 이름입니다. 이 테이블은 sn_install_base_item 테이블을 확장해야 합니다. 데이터 유형: 문자열 | | sysparm_depth | 반환할 하위 설치 기반 항목 계층 구조의 최대 깊이입니다. 데이터 형식: 정수 기본값: 7 최대: 10 | | sysparm_limit | 각 하위 계층 구조에서 반환할 최대 기록 수입니다. 데이터 형식: 정수 기본값: 10 최대: 100 | [표 14. 쿼리 매개변수] {#integrat-GET-installbaseitems-id__entry__16} | 이름 | 설명 | |-|-| | 없음 | | [표 15. 요청 본문 매개변수(XML 또는 JSON)] ### 헤더 다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 [지원되는 REST API 헤더를](https://servicenow-prod.fluidtopics.net/JHL64oGR2SkU25ZTkfHy7g "REST(REpresentational State Transfer)는 웹상의 컴퓨터 시스템 간에 표준을 제공하여 서로 보다 쉽게 통신할 수 있게 지원하는 단순한 상태 비저장 아키텍처입니다.") 참조하세요. {#integrat-GET-installbaseitems-id__entry__20}{#integrat-GET-installbaseitems-id__accept-RESTAPI} | 헤더 | 설명 | |-|-| | 수용 | 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json | [표 16. 요청 헤더] {#integrat-GET-installbaseitems-id__entry__24} | 헤더 | 설명 | |-|-| | 없음 | | [표 17. 응답 헤더] ### 상태 코드 다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 [REST API HTTP 응답 코드를](https://servicenow-prod.fluidtopics.net/JHL64oGR2SkU25ZTkfHy7g "REST(REpresentational State Transfer)는 웹상의 컴퓨터 시스템 간에 표준을 제공하여 서로 보다 쉽게 통신할 수 있게 지원하는 단순한 상태 비저장 아키텍처입니다.") 참조하세요. {#integrat-GET-installbaseitems-id__entry__28}{#integrat-GET-installbaseitems-id__entry-200-status-code}{#integrat-GET-installbaseitems-id__entry-400-status-code}{#integrat-GET-installbaseitems-id__entry-403-status-code}{#integrat-GET-installbaseitems-id__entry-404-status-code}{#integrat-GET-installbaseitems-id__entry-500-status-code} | 상태 코드 | 설명 | |-|-| | 200 | 성공입니다. 요청이 성공적으로 처리되었습니다. | | 400 | 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다. | | 403 | 금지되었습니다. 사용자에게 지정된 기록에 대한 액세스 권한이 없습니다. | | 404 | 찾을 수 없습니다. 요청한 항목을 찾을 수 없습니다. | | 500 | 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다. | [표 18. 상태 코드] ### 응답 본문 매개변수(JSON 또는 XML) {#integrat-GET-installbaseitems-id__id_fw5_m3f_xwb__entry__2}{#integrat-GET-installbaseitems-id__error-integration-entry}{#integrat-GET-installbaseitems-id__error_detail-integration-entry}{#integrat-GET-installbaseitems-id__error_message-integration-entry}{#integrat-GET-installbaseitems-id__account-integration-row}{#integrat-GET-installbaseitems-id__account_display_value-integration-row}{#integrat-GET-installbaseitems-id__account_sys_id-integration-row}{#integrat-GET-installbaseitems-id__active-integration-row}{#integrat-GET-installbaseitems-id__name-integration-row}{#integrat-GET-installbaseitems-id__number-integration-row}{#integrat-GET-installbaseitems-id__sys_class_name-integration-row}{#integrat-GET-installbaseitems-id__sys_id-integration-row}{#integrat-GET-installbaseitems-id__state-integration-row}{#integrat-GET-installbaseitems-id__state_display_value-integration-row}{#integrat-GET-installbaseitems-id__state_value-integration-row}{#integrat-GET-installbaseitems-id__status-integration-row} | 이름 | 설명 | |-|-| | ChildInstallBase | 지정된 설치 기반 항목과 연결된 하위 설치 기반 항목 기록의 목록입니다. 데이터 유형: 객체 "childinstallbase": { "items": [Array], "sysparm_depth": Integer } | | childinstallbase.items | 지정된 설치 기반 항목과 연결된 하위 설치 기반 항목입니다. 이 배열 내의 값은 이 섹션의 아래쪽에 있는 items\[\] 배열 아래에 정의됩니다. | | childinstallbase.sysparm_depth | 설치 기반 항목의 하위 수준입니다. 데이터 형식: 정수 | | 오류 | 요청을 처리하려고 할 때 발생한 오류에 대한 상세 정보입니다. 데이터 유형: 객체 "error": { "detail": "String", "message": "String" } | | 오류.상세 정보 | 관련 오류에 대한 추가 정보입니다. 데이터 유형: 문자열 | | 오류.메시지 | 요청을 실행하려고 할 때 발생한 문제를 설명하는 오류 메시지입니다. 데이터 유형: 문자열 | | has_children | 요청된 설치 기반 항목 기록에 하위 설치 기반 항목 기록이 있는지 여부를 나타내는 플래그입니다. * true: 하위 설치 기반 항목 기록이 있습니다. * false: 하위 설치 기반 항목 레코드가 없습니다. 데이터 유형: 부울 | | 항목 | 지정된 필터 결과와 일치하는 설치 기반 항목입니다. 데이터 형식: 객체 배열 "item": { "account": {Object}, "active": "String", "asset": {Object}, "configuration_item": {Object}, "consumer": {Object}, "consumer_profile": {Object}, "contact": {Object}, "health_status": "Object", "health_status_last_updated": "String", "household": {Object}, "install_date": {Object}, "location": {Object}, "name": "String", "number": "String", "parent": {Object}, "product": {Object}, "service_context": {Object}, "service_organization" {Object}, "sys_class_name": "String", "sys_id": "String", "state": {Object}, "status": {Object}, "uninstall_date": "String" } | | item.account | 설치 기반 항목 기록과 연결된 고객 계정에 대한 세부 정보입니다. 데이터 유형: 객체 "account": { "display_value": "String", "sys_id": "String" } | | item.account.display_value | 설치 기반 항목 기록과 연결된 고객 계정의 텍스트 이름입니다. 이 값을 사용하여 UI에 고객 계정 이름을 표시합니다. 데이터 유형: 문자열 | | item.account.sys_id | 설치 기반 항목 기록과 연결된 고객 계정 기록의 Sys_id입니다. 데이터 유형: 문자열 | | item.active | 설치 기반 항목이 활성 상태인지 여부를 나타내는 플래그입니다. 가능한 값: * true: 설치 기반 항목이 활성 상태입니다. * false: 설치 기반 항목이 비활성 상태입니다. 데이터 유형: 부울 문자열 | | item.asset | 설치 기반 항목 기록과 연결된 자산에 대한 세부 정보입니다. 데이터 유형: 객체 "asset": { "display_value": "String", "sys_id": "String" } | | item.asset.display_value | 설치 기반 항목 기록과 연결된 자산의 텍스트 이름입니다. 이 값을 사용하여 UI에 자산 이름을 표시합니다. 데이터 유형: 문자열 | | item.asset.sys_id | 설치 기반 항목 기록과 연결된 자산 기록의 Sys_id입니다. 데이터 유형: 문자열 | | item.configuration_item | 설치 기반 항목 기록과 연결된 구성 항목에 대한 세부 정보입니다. 데이터 유형: 객체 "configuration_item": { "display_value": "String", "sys_id": "String" } | | item.configuration_item.display_value | 설치 기반 항목 기록과 연결된 구성 항목의 텍스트 이름입니다. 이 값을 사용하여 UI에 구성 항목 이름을 표시합니다. 데이터 유형: 문자열 | | item.configuration_item.sys_id | 설치 기반 항목 기록과 연결된 구성 항목 기록의 Sys_id입니다. 데이터 유형: 문자열 | | item.consumer | 설치 기반 항목 기록과 연결된 소비자에 대한 세부 정보입니다. 주: 소비자 필드는 B2B2C 플러그인이 설치된 경우에만 사용할 수 있습니다. 데이터 유형: 객체 "consumer": { "display_value": "String", "sys_id": "String" } | | item.consumer.display_value | 설치 기반 항목 기록과 연결된 소비자의 텍스트 이름입니다. 이 값을 사용하여 UI에 소비자 이름을 표시합니다. 데이터 유형: 문자열 | | item.consumer.sys_id | 설치 기반 항목 기록과 연결된 소비자 기록의 Sys_id입니다. 데이터 유형: 문자열 | | item.consumer_profile | 설치 기반 항목 기록과 연결된 소비자 프로필에 대한 세부 정보입니다. 주: 소비자 프로필 필드는 B2B2C 플러그인이 설치된 경우에만 사용할 수 있습니다. 데이터 유형: 객체 "consumer_profile": { "display_value": "String", "sys_id": "String" } | | item.consumer_profile.display_value | 설치 기반 항목 기록과 연결된 소비자 프로필의 텍스트 이름입니다. 이 값을 사용하여 UI에 소비자 프로파일 이름을 표시합니다. 데이터 유형: 문자열 | | item.consumer_profile.sys_id | 설치 기반 항목 기록과 연결된 소비자 프로필 기록의 Sys_id입니다. 데이터 유형: 문자열 | | item.contact | 설치 기반 항목 기록을 담당하는 계정 접촉 창구에 대한 세부 정보입니다. 데이터 유형: 객체 "contact": { "display_value": "String", "sys_id": "String" } | | item.contact.display_value | 설치 기반 항목 기록과 연결된 계정 연락처의 텍스트 이름입니다. 이 값을 사용하여 UI에 계정 접촉 창구 이름을 표시합니다. 데이터 유형: 문자열 | | item.contact.sys_id | 설치 기반 항목 기록과 연결된 계정 연락처 기록의 Sys_id입니다. 데이터 유형: 문자열 | | item.health_status | 설치 기반 항목의 현재 상태에 대한 세부 정보입니다. com.snc.proactive_cs_itom(사전 예방적 고객 서비스 운영) 플러그인이 설치된 경우에만 반환됩니다. 데이터 유형: 객체 "health_status": { "display_value": "String", "value": "String" } | | item.health_status.display_value | 설치 기반 항목의 현재 상태를 나타내는 텍스트 문자열입니다. 이 값을 사용하여 UI에 상태를 표시합니다. 데이터 유형: 문자열 | | item.health_status.value | 설치 기반 항목의 상태에 대한 내부 값입니다. 데이터 유형: 문자열 | | item.health_status_last_updated | 설치 기반 항목의 상태가 마지막으로 업데이트된 날짜 및 시간입니다. 데이터 유형: 문자열 | | item.household | 설치 기반 항목 기록과 연결된 세대에 대한 세부 정보입니다. Customer Service Household(com.snc.household) 플러그인이 설치된 경우에만 반환됩니다. 데이터 유형: 객체 "household": { "display_value": "String", "sys_id": "String" } | | item.household.display_value | 설치 기반 항목 기록과 연결된 세대의 텍스트 이름입니다. 이 값을 사용하여 UI에 세대 이름을 표시합니다. 데이터 유형: 문자열 | | item.household.sys_id | 설치 기반 항목 기록과 연결된 세대 Sys_id입니다. 데이터 유형: 문자열 | | item.install_date | 설치 기반 항목이 활성화된 날짜에 대한 세부 정보입니다. 데이터 유형: 객체 "install_date": { "display_value": "String", "value": "String" } | | item.install_date.display_value | 텍스트 설치 날짜입니다. 이 값을 사용하여 UI에 설치 날짜를 표시합니다. 데이터 유형: 문자열 | | item.install_date.값 | 설치 날짜의 내부 값입니다. 데이터 유형: 문자열 | | item.location | 설치 기반 항목의 위치에 대한 세부 정보입니다. 데이터 유형: 객체 "location": { "display_value": "String", "sys_id": "String" } | | item.location.display_value | 설치 기반 항목 위치의 텍스트 이름입니다. 이 값을 사용하여 UI에 위치 이름을 표시합니다. 데이터 유형: 문자열 | | item.location.sys_id | 설치 기반 항목 기록과 연결된 위치 기록의 Sys_id입니다. 데이터 유형: 문자열 | | item.name | 설치 기반 항목의 이름입니다. 데이터 유형: 문자열 | | item.number | 설치 기반 항목의 고유 ID입니다. 데이터 유형: 문자열 | | item.parent | 설치 기반 항목 기록의 상위 기록에 대한 세부 정보입니다. 데이터 유형: 객체 "parent": { "display_value": "String", "sys_id": "String" } | | item.parent.display_value | 설치 기반 항목 기록과 연결된 상위 기록의 텍스트 이름입니다. 이 값을 사용하여 UI에 상위 이름을 표시합니다. 데이터 유형: 문자열 | | item.parent.sys_id | 설치 기반 항목 기록과 연결된 상위 기록의 Sys_id입니다. 데이터 유형: 문자열 | | item.product | 설치 기반 항목 기록과 연결된 제품 모델에 대한 세부 정보입니다. 이 정보를 사용하여 제품 모델과 연결된 서비스를 식별합니다. 데이터 유형: 객체 "product": { "display_value": "String", "sys_id": "String" } | | item.product.display_value | 설치 기반 항목 기록과 연결된 제품 모델의 텍스트 이름입니다. 이 값을 사용하여 UI에 제품 이름을 표시합니다. 데이터 유형: 문자열 | | item.product.sys_id | 설치 기반 항목 기록과 연결된 제품 모델 기록의 Sys_id입니다. 데이터 유형: 문자열 | | item.service_context | 설치 기반 항목 기록과 연결된 서비스 컨텍스트에 대한 상세 정보입니다. 데이터 유형: 객체 "service_context": { "display_value": "String", "sys_id": "String" } | | item.service_context.display_value | 설치 기반 항목 기록과 연결된 서비스 컨텍스트에 대한 상세 정보입니다. 데이터 유형: 객체 "service_context": { "display_value": "String", "sys_id": "String" } | | item.service_context.sys_id | 설치 기반 항목 기록과 연결된 서비스 컨텍스트 기록의 Sys_id입니다. 데이터 유형: 문자열 | | item.service_organization | 설치 기반 항목 기록과 연결된 서비스 조직에 대한 세부 정보입니다. Service Organization(com.snc.service_organization) 플러그인이 설치된 경우에만 반환됩니다. 데이터 유형: 객체 "service_organization": { "display_value": "String", "sys_id": "String" } | | item.service_organization.display_value | 설치 기반 항목 기록과 연결된 서비스 조직의 텍스트 이름입니다. 이 값을 사용하여 UI에 서비스 조직 이름을 표시합니다. 데이터 유형: 문자열 | | item.service_organization.sys_id | 설치 기반 항목 기록과 연결된 서비스 조직 기록의 Sys_id입니다. 데이터 유형: 문자열 | | item.sys_클래스_이름 | 설치 기반 항목 기록을 포함하는 테이블입니다. 데이터 유형: 문자열 | | item.sys_id | 설치 기반 항목 기록의 Sys_id입니다. 매개변수에 지정된 sys_class_name 테이블에 있습니다. 데이터 유형: 문자열 | | item.sys_mod_count | 연결된 설치 기반 항목 기록이 수정된 횟수입니다. 데이터 유형: 문자열 | | item.state | 설치 기반 항목의 현재 상태에 대한 세부 정보입니다. 데이터 유형: 객체 "state": { "display_value": "String", "value": "String" } | | item.state.display_value | 설치 기반 항목의 현재 상태에 대한 텍스트 문자열입니다. 이 값을 사용하여 UI에 상태를 표시합니다. 데이터 유형: 문자열 | | item.state.value | 설치 기반 항목의 상태에 대한 내부 값입니다. 데이터 유형: 문자열 | | item.status | 설치 기반 항목의 상태에 대한 세부 정보입니다. 데이터 유형: 객체 "status": { "display_value": "String", "value": "String" } | | item.status.display_value | 설치 기반 항목의 상태에 대한 텍스트 문자열입니다. 이 값을 사용하여 UI에 상태를 표시합니다. 데이터 유형: 문자열 | | item.status.value | 설치 기반 항목의 상태에 대한 내부 값입니다. 데이터 유형: 문자열 | | item.uninstall_date | 설치 기반 항목이 비활성 상태가 된 날짜에 대한 세부 정보입니다. 데이터 유형: 객체 "uninstall_date": { "display_value": "String", "value": "String" } | | item.uninstall_date.display_value | 텍스트 제거 날짜. 이 값을 사용하여 UI에 제거 날짜를 표시합니다. 데이터 유형: 문자열 | | item.uninstall_date.value | 제거 날짜의 내부 값입니다. 데이터 유형: 문자열 | | 상태 | 엔드포인트 호출의 상태입니다. 데이터 유형: 문자열 | [ ] {#integrat-GET-installbaseitems-id__id_fw5_m3f_xwb} ### cURL 요청 다음 코드 예제에서는 이 끝점을 호출하는 방법을 보여 줍니다. 연결된 설치 기반 항목에 하위 항목이 없습니다. curl "https://instance.servicenow.com/api/sn_install_base/integrations/installbaseitem/f77c7542b7343300ece839a6ee11a991" \ --request GET \ --header "Accept:application/json" \ --user 'username':'password' 반환 결과: { "result": { "status": "SUCCESS", "item": { "sys_class_name": "sn_install_base_item", "number": "IBITM0000901", "sys_id": "f77c7542b7343300ece839a6ee11a991", "product": { "sys_id": "8583ce8237732000158bbfc8bcbe5dd9", "display_value": "Fujitsu 1TB Hybrid Solid State Drive" }, "active": "true", "name": "KX Series - KX5001", "account": { "sys_id": "86837a386f0331003b3c498f5d3ee4ca", "display_value": "Boxeo" } }, "hasChildren": "false" } } ### cURL 요청 {#integrat-GET-installbaseitems-id__example_zsw_b5v_1xb} 다음 코드 예제에서는 최대 4개의 자식 수준을 지정하여 이 끝점을 호출하는 방법을 보여 줍니다. curl "https://instance.servicenow.com/api/sn_install_base/integrations/installbaseitems/e0a80e4b87b521100b6afc86dabb3565?depth=4" \ --request GET \ --header "Accept:application/json" \ --user 'username':'password' 반환 결과: { "result": { "status": "SUCCESS", "item": { "sys_class_name": "sn_install_base_item", "number": "IBITM0001073", "sys_id": "e0a80e4b87b521100b6afc86dabb3565", "health_status": { "value": "not_available", "display_value": "Not Available" }, "active": "true", "name": "parent", "account": { "sys_id": "86837a386f0331003b3c498f5d3ee4ca", "display_value": "Boxeo" } }, "hasChildren": "true", "childinstallbase": { "sysparm_depth": 2, "items": [ { "parent": { "sys_id": "e0a80e4b87b521100b6afc86dabb3565", "display_value": "parent" }, "sys_class_name": "sn_install_base_item", "number": "IBITM0001074", "sys_id": "6db80e4b87b521100b6afc86dabb356b", "state": { "value": "in_use", "display_value": "In Use" }, "health_status": { "value": "not_available", "display_value": "Not Available" }, "active": "true", "name": "child1", "account": { "sys_id": "86837a386f0331003b3c498f5d3ee4ca", "display_value": "Boxeo" }, "hasChildren": "true", "items": { "sysparm_depth": 3, "items": [ { "parent": { "sys_id": "6db80e4b87b521100b6afc86dabb356b", "display_value": "child1" }, "sys_class_name": "sn_install_base_item", "number": "IBITM0001075", "sys_id": "36ecce4b87b521100b6afc86dabb3503", "health_status": { "value": "not_available", "display_value": "Not Available" }, "active": "true", "name": "childL2", "account": { "sys_id": "86837a386f0331003b3c498f5d3ee4ca", "display_value": "Boxeo" }, "hasChildren": "false" } ] } } ] } } } ## 설치 기반 항목 - GET /sn_install_base/integrations/installbaseitems/{id}/cases {#ariaid-title5} 지정된 설치 기반 항목 기록과 연결된 케이스를 반환합니다.
### URL 형식 버전이 지정된 URL: /api/sn_install_base/{api_version}/integrations/installbaseitems/{id}/cases 기본 URL: /api/sn_install_base/integrations/installbaseitems/{id}/cases ### 지원되는 요청 매개변수 {#integrat-GET-cases__entry__2}{#integrat-GET-cases__version-RESTAPI}{#integrat-GET-cases__integrate-id-entry} | 이름 | 설명 | |-|-| | api_version | 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열 | | id | 설치 기반 항목 기록의 Sys_id입니다. 설치 기반 항목 \[sn_install_base_item\] 테이블에 있습니다. 데이터 유형: 문자열 | [표 19. 경로 매개변수] {#integrat-GET-cases__entry__8}{#integrat-GET-cases__sysparm-limit-RESTAPI}{#integrat-GET-cases__sysparm_offset-ph-RESTAPI} | 이름 | 설명 | |-|-| | 필드 이름-값 쌍 | 케이스 기록을 필터링하는 데 사용할 필드-값 쌍입니다. 기본적으로 이 필드는 케이스 \[sn_customerservice_case\] 테이블의 필드를 참조합니다. 에서 sys_class_name다른 테이블을 지정하는 경우 해당 테이블의 필드를 지정합니다. 하나 이상의 필드-값 쌍을 전달하여 반환 결과를 필터링할 수 있습니다. 예를 들어 승인 필드가 "거부됨"으로 설정되고 범주 필드가 "2"로 설정된 기록만 반환하려면 `&승인=거부됨&범주=2`를 전달합니다. 데이터 유형: 문자열 기본값: 모든 필드 | | sys_class_name | 확장 케이스 테이블(sn_customerservice_case 아님)을 사용하는 경우 쿼리할 확장 테이블의 이름입니다. 데이터 유형: 문자열 기본값: sn_customerservice_case | | sysparm_limit | 반환할 최대 기록 수입니다. 이 기록 수를 초과하는 요청의 경우 sysparm_offset 매개변수를 사용하여 기록 검색을 페이지 매김합니다. 이 제한은 ACL 평가 전에 적용됩니다. 액세스할 수 있는 기록을 포함하여 반환되는 기록이 없으면 액세스할 수 있는 기록이 먼저 반환되도록 기록 순서를 다시 정렬합니다. 주: 이례적으로 큰 sysparm_limit 값은 시스템 성능에 영향을 미칠 수 있습니다. 데이터 유형: 숫자 기본값: 10000 | | sysparm_offset | 기록 검색을 시작할 시작 기록 인덱스입니다. 이 값을 사용하여 기록 검색을 페이지 매김합니다. 이 기능을 사용하면 기록 수와 관계없이 관리 가능한 작은 청크로 모든 기록을 검색할 수 있습니다. 예를 들어 이 엔드포인트를 처음 호출할 때 sysparm_offset이 "0"으로 설정됩니다. 사용 가능한 모든 기록을 간단히 살펴보려면 모든 기록이 끝날 때까지 `sysparm_offset=sysparm_offset+sysparm_limit`를 사용합니다.{#integrat-GET-cases__sysparm_offset-p-RESTAPI} 매개 변수에 sysparm_offset 음수를 전달하지 마세요. 데이터 유형: 숫자 기본값: 0 | [표 20. 쿼리 매개변수] {#integrat-GET-cases__entry__18} | 이름 | 설명 | |-|-| | 없음 | | [표 21. 요청 본문 매개변수(XML 또는 JSON)] ### 헤더 다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 [지원되는 REST API 헤더를](https://servicenow-prod.fluidtopics.net/JHL64oGR2SkU25ZTkfHy7g "REST(REpresentational State Transfer)는 웹상의 컴퓨터 시스템 간에 표준을 제공하여 서로 보다 쉽게 통신할 수 있게 지원하는 단순한 상태 비저장 아키텍처입니다.") 참조하세요. {#integrat-GET-cases__entry__22}{#integrat-GET-cases__accept-RESTAPI} | 헤더 | 설명 | |-|-| | 수용 | 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json | [표 22. 요청 헤더] {#integrat-GET-cases__entry__26} | 헤더 | 설명 | |-|-| | 없음 | | [표 23. 응답 헤더] ### 상태 코드 다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 [REST API HTTP 응답 코드를](https://servicenow-prod.fluidtopics.net/JHL64oGR2SkU25ZTkfHy7g "REST(REpresentational State Transfer)는 웹상의 컴퓨터 시스템 간에 표준을 제공하여 서로 보다 쉽게 통신할 수 있게 지원하는 단순한 상태 비저장 아키텍처입니다.") 참조하세요. {#integrat-GET-cases__entry__30}{#integrat-GET-cases__entry-200-status-code}{#integrat-GET-cases__entry-400-status-code}{#integrat-GET-cases__entry-403-status-code}{#integrat-GET-cases__entry-404-status-code}{#integrat-GET-cases__entry-500-status-code} | 상태 코드 | 설명 | |-|-| | 200 | 성공입니다. 요청이 성공적으로 처리되었습니다. | | 400 | 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다. | | 403 | 금지되었습니다. 사용자에게 지정된 기록에 대한 액세스 권한이 없습니다. | | 404 | 찾을 수 없습니다. 요청한 항목을 찾을 수 없습니다. | | 500 | 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다. | [표 24. 상태 코드] ### 응답 본문 매개변수(JSON 또는 XML) {#integrat-GET-cases__entry__42}{#integrat-GET-cases__casetable-account-ph}{#integrat-GET-cases__assigned_to_desc}{#integrat-GET-cases__casetable-contact_type-maxLength}{#integrat-GET-cases__description_maxLength}{#integrat-GET-cases__priority_default}{#integrat-GET-cases__short_description_maxLength}{#integrat-GET-cases__has_more-integration-entry}{#integrat-GET-cases__status-integration-entry}{#integrat-GET-cases__sysparm-limit-entry}{#integrat-GET-cases__sysparm-offset-entry} | 요소 | 설명 | |-|-| | 케이스 | 지정된 설치 기반 항목 기록과 연결된 케이스의 목록입니다. 데이터 형식: 객체 배열 "cases": [ { "account": "String", "active": Boolean, "active_account_escalation": "String", "active_escalation": "String", "activity_due": "String", "additional_assignee_list": "String", "approval": "String", "approval_history": "String", "approval_set": "String", "asset": "String", "assigned_on": "String", "assigned_to": "String", "assignment_group": "String", "auto_close": Boolean, "business_duration": "String", "business_impact": "String", "business_service": "String", "calendar_duration": "String", "case": "String", "case_report": "String", "category": Number, "cause": "String", "caused_by": "String", "change": "String", "child_case_creation_progress": Boolean, "closed_at": "String", "closed_by": "String", "close_notes: "String", "cmdb_ci": "String", "comments": "String", "comments_and_work_notes": "String", "company": "String", "consumer": "String", "contact": "String", "contact_local_time: "String", "contact_time_zone": "String", "contact_type": "String", "contract": "String", "contributor_groups": "String", "contributor_users": "String", "correlation_display": "String", "correlation_id": "String", "delivery_plan": "String", "delivery_task": "String", "description": "string", "due_date": "String", "entitlement": "String", "escalation": Number, "expected_start": "String", "first_response_time": "String", "follow_the_sun": Boolean, "follow_up": "String", "group_list": [Array], "impact": Number, "internal_user": "String", "initiated_as_request": Boolean, "knowledge": Boolean, "location": "String", "made_sla": Boolean, "major_case_state": "String", "needs_attention": Boolean, "notes_to_comments": Boolean, "notify": Number, "number": "String", "opened_at": "String", "opened_by": "String", "order": Number, "parent": "String", "partner": "String", "partner_contact": "String", "priority": Number, "proactive": Boolean, "probable_cause": "String", "problem": "String", "product": "String", "reassignment_count": Number, "recipient_list": "String", "rejection_goto": "String", "resolution_code": "String", "resolved_at": "String", "resolved_by": "String", "route_reason": "String", "service_offering": "String", "short_description": "String", "skills": "String", "sla_due": "String", "sn_app_cs_social_social_profile": "String", "sold_product": "String", "stage": "String", "state": Number, "subcategory": Number, "support_manager" "String", "sync_driver": Boolean, "sys_class_name": "String", "sys_domain": "String", "sys_domain_path": "String", "sys_id": "String", "task_effective_number": "String", "time_worked": "String", "universal_request": "String", "upon_approval": "String", "upon_reject": "String", "urgency": Number, "user_input": "String", "variables": "String", "watch_list": [Array], "wf_activity": "String", "work_end": "String", "work_notes": "String", "work_notes_list": [Array], "work_start": "String" | | 케이스.계정 | 케이스와 연결된 계정 기록의 Sys_id입니다. 계정 \[customer_account\] 테이블에 있습니다. 데이터 유형: 문자열 | | 케이스.활성 | 케이스가 열려 있고 활성 상태인지 여부를 나타내는 플래그입니다. 가능한 값: * true: 케이스가 활성 상태임 * false: 케이스가 종결됨 데이터 유형: 부울 기본값: true | | cases.active_account_escalation | 케이스와 연결된 활성 계정 에스컬레이션 기록의 Sys_id입니다. 에스컬레이션 \[sn_customerservice_escalation\] 테이블에 있습니다. 데이터 유형: 문자열 | | cases.active_escalation | 케이스와 연결된 활성 에스컬레이션 기록의 Sys_id입니다. 에스컬레이션 \[sn_customerservice_escalation\] 테이블에 있습니다. 데이터 유형: 문자열 | | cases.activity_due | 관련 케이스가 완료될 것으로 예상되는 날짜입니다. 데이터 유형: 문자열 | | cases.additional_assignee_list | 계정에 할당된 추가 사용자(기본 담당자 제외)의 sys_ids 목록입니다. 사용자 \[sys_user\] 테이블에 있습니다. 데이터 유형: 배열 최대: 4,000 | | 케이스.승인 | 필요한 승인 유형을 설명하는 문자열입니다. 가능한 값: * 승인됨 * 취소됨 * 복사하다 * not_required * 요청 안 함 * 거부됨 * requested 데이터 유형: 문자열 최대 문자 수: 40 기본값: 요청되지 않음 | | cases.approval_history | 케이스와 연결된 모든 승인의 목록입니다. 데이터 유형: 문자열 최대 글자 수: 4,000 | | cases.approval_set | 연결된 작업이 승인된 날짜 및 시간입니다. 데이터 유형: 문자열 | | 케이스.자산 | 케이스와 연결된 자산 기록의 Sys_id입니다. 자산 \[alm_asset\] 테이블에 있습니다. 데이터 유형: 문자열 | | cases.assigned_on | 매개변수에서 식별된 사람에게 케이스가 할당된 날짜 및 시간입니다 assigned_to . 데이터 형식: 문자열(날짜) 최대 길이: 40 | | cases.assigned_to | 케이스에 할당된 사람의 Sys_id입니다. 사용자 \[sys_user\] 테이블에 있습니다. 데이터 유형: 문자열 | | cases.assignment_group | 케이스에 할당된 고객 서비스 에이전트 그룹의 Sys_id입니다. 그룹 \[sys_user_group\] 테이블에 있습니다. 데이터 유형: 문자열 | | cases.auto_close | 케이스가 자동으로 종결되었는지 여부를 나타내는 플래그입니다. 가능한 값: * true: 케이스가 자동으로 종결되었습니다. * false: 케이스가 자동으로 종결되지 않음 데이터 유형: 부울 기본값: false | | cases.business_duration | 케이스를 완료하는 데 걸린 달력 작업 시간, 작업일 및 작업 주간의 길이입니다. 데이터 유형: 문자열 | | cases.business_impact | 관련 고객에 대한 문제의 영향입니다. 데이터 유형: 문자열 최대 글자 수: 4,000 | | cases.business_service | 케이스와 연결된 서비스 기록의 Sys_id입니다. 서비스 \[cmdb_ci_service\] 테이블에 있습니다. 데이터 유형: 문자열 | | cases.calendar_duration | 케이스를 완료하는 데 걸린 달력 시간, 일 및 주 길이입니다. 데이터 형식: 문자열(기간) 최대 길이: 40 | | 케이스.케이스 | 케이스에 대한 짧은 설명 및 케이스 번호입니다. 데이터 유형: 문자열 최대 길이: 300 | | cases.case_report | 관련 케이스 보고서의 Sys_id입니다. 케이스 보고서 \[sn_customerservice_case_report\] 테이블에 있습니다. 데이터 유형: 문자열 | | 케이스.범주 | 케이스 범주. 가능한 값: * 0: 질문 * 1: 문제 * 2 : 특징 데이터 형식: 숫자(정수) 기본값: 1 | | 케이스.원인 | 문제의 원인에 대한 상세 정보입니다. 데이터 유형: 문자열 최대 길이: 4,000 | | cases.caused_by | 케이스를 생성한 변경 요청의 Sys_id입니다. 변경 요청 \[change_request\] 테이블에 있습니다. 데이터 유형: 문자열 | | 케이스.변경 | 케이스를 생성한 변경 요청의 Sys_id입니다. 변경 요청 \[change_request\] 테이블에 있습니다. 데이터 유형: 문자열 | | cases.child_case_creation_progress | 케이스가 중요 케이스에서 만들어진 하위 케이스인지 여부를 나타내는 플래그입니다. 가능한 값: * true: 중요 케이스에서 하위 케이스를 만들었습니다. * false: 하위 케이스가 아님 데이터 유형: 부울 | | cases.closed_at | 케이스가 종결된 날짜 및 시간입니다. 데이터 유형: 문자열 | | cases.closed_by | 케이스를 종결한 사용자의 Sys_id입니다. 사용자 \[sys_user\] 테이블에 있습니다. 데이터 유형: 문자열 | | cases.close_notes | 케이스가 종결될 때 작성한 메모입니다. 데이터 유형: 문자열 최대 길이: 4,000 | | cases.cmdb_ci | 케이스와 연결된 구성 항목의 Sys_id입니다. 구성 항목 \[cmdb_ci\] 테이블에 있습니다. 데이터 유형: 문자열 | | 케이스.코멘트 | 케이스에 대한 추가 코멘트입니다. 데이터 유형: 문자열 최대 길이: 4,000 | | cases.comments_and_work_notes | 케이스에 대해 입력된 코멘트 및 작업 메모입니다. 데이터 유형: 문자열 최대 길이: 4,000 | | 케이스.회사 | 케이스와 연결된 회사의 Sys_id입니다. 회사 \[core_company\] 테이블에 있습니다. 데이터 유형: 문자열 | | 케이스.소비자 | B2C(business-to-consumer) 케이스에만 해당됩니다. 이 케이스와 관련하여 연락할 사람의 Sys_id입니다. 소비자 \[csm_consumer\] 테이블에 있습니다. 데이터 유형: 문자열 | | 케이스.접촉 창구 | B2B(business-to-business) 기반 케이스에만 해당됩니다. 이 케이스와 관련하여 연락할 사람의 Sys_id입니다. 연락처 \[customer_contact\] 테이블에 있습니다. 데이터 유형: 문자열 | | cases.contact_local_time | 현지 시간에 문의하십시오. 데이터 유형: 문자열 최대 길이: 70 | | cases.contact_time_zone | 케이스와 연결된 접촉 창구의 시간대입니다. 데이터 유형: 문자열 최대 길이: 40 | | cases.contact_type | 케이스가 처음 보고된 방법입니다. 가능한 값: * 채팅 * 이메일 * 전화 * 사회적인 * 웹 데이터 유형: 문자열 최대 길이: 40 | | 케이스.계약 | 케이스와 연결된 계약의 Sys_id입니다. 계약 \[ast_contract\] 테이블에 있습니다. 이 계약에는 케이스와 관련된 회사에 제공되는 지원 유형에 대한 정보가 포함되어 있습니다. 계약에는 회사 및 접촉 창구와 보장되는 특정 자산이 포함될 수 있습니다. 계약에는 여러 서비스 권리와 SLA도 포함될 수 있습니다. 데이터 유형: 문자열 | | cases.contributor_groups | 케이스에 기여한 사용자 그룹의 sys_ids 목록입니다. 그룹 \[sys_user_group\] 테이블에 있습니다. 데이터 유형: 문자열 | | cases.contributor_users | 케이스에 기여한 사용자의 sys_ids 목록입니다. 사용자 \[sys_user\] 테이블에 있습니다. 데이터 유형: 문자열 | | cases.correlation_display | 상관 관계 표시. 데이터 유형: 문자열 최대 길이: 100 | | cases.correlation_id | 상관 관계 식별자입니다. 데이터 유형: 문자열 최대 길이: 100 | | cases.delivery_plan | 이 케이스에 대한 상위 실행 계획의 Sys_id입니다. 실행 계획 \[sc_cat_item_delivery_plan\] 테이블에 있습니다. 데이터 유형: 문자열 | | cases.delivery_task | 실행 계획 작업의 Sys_id입니다. 실행 계획 작업 \[sc_cat_item_delivery_task\] 테이블에 있습니다. 데이터 유형: 문자열 | | 케이스.설명 | 케이스와 연결된 문제에 대한 자세한 설명입니다. 데이터 유형: 문자열 최대 길이: 4,000 | | cases.due_date | 케이스가 종결되어야 할 날짜입니다. 데이터 유형: 문자열 | | 케이스.권리 | 케이스와 연결된 권리 기록의 Sys_id입니다. 권리 \[service_entitlement\] 테이블에 있습니다. 권리는 고객이 받는 지원 유형 및 지원되는 커뮤니케이션 채널을 정의합니다. 권리는 제품, 자산, 계정 또는 계약과 연결할 수 있습니다. 데이터 유형: 문자열 | | 케이스.에스컬레이션 | 현재 에스컬레이션 수준입니다. 가능한 값: * 0: 정상 * 1: 보통 * 2: 높음 * 3: 기한 초과 데이터 형식: 숫자(정수) 기본값: 0 | | cases.expected_start | 케이스에 대한 작업이 시작될 날짜 및 시간입니다. 데이터 유형: 문자열 | | cases.first_response_time | 케이스에 대해 첫 번째 작업이 수행된 날짜 및 시간입니다. 데이터 유형: 문자열 | | cases.follow_the_sun | 전역 후속 조치를 위해 케이스를 전달해야 하는지 여부를 나타내는 플래그입니다. 고객이 우선순위 1 - 중요 또는 우선순위 2 - 높음 케이스에 추가 코멘트를 입력하거나 케이스가 에스컬레이션되면 플래그가 자동으로 true로 설정됩니다. 가능한 값: * true: 전역 후속 조치를 위해 케이스를 전달해야 합니다. * false: 전역 후속 조치를 위해 케이스를 전달해서는 안 됩니다. 데이터 유형: 부울 기본값: false | | cases.follow_up | 다음 후속 작업의 날짜 및 시간입니다. 데이터 유형: 문자열 | | cases.group_list | 케이스와 연결된 그룹 기록의 sys_ids 목록입니다. 그룹 \[sys_user_group\] 테이블에 있습니다. 데이터 유형: 배열 | | 케이스.영향 | 고객에게 미치는 영향 가능한 값: * 1: 높음 * 2: 중간 * 3: 낮음 데이터 형식: 숫자(정수) 기본값: 3 | | cases.internal_user | 이 케이스에 대한 내부 사용자의 Sys_id입니다. 사용자 \[sys_user\] 테이블에 있습니다. 데이터 유형: 문자열 | | cases.initiated_as_request | 이 문의가 고객의 요청으로 시작되었는지 여부를 나타내는 플래그입니다. 가능한 값: * true: 고객이 시작한 문의입니다. * false: 고객이 문의를 시작하지 않았습니다. 데이터 유형: 부울 기본값: false | | 케이스.지식 | 특정 문제에 사용할 수 있는 지식베이스 문서가 있는지 나타내는 플래그입니다. 가능한 값: * true: 이 문제에 대한 지식베이스 문서를 사용할 수 있음 * false: 이 문제에 대한 지식베이스 문서를 사용할 수 없습니다. 데이터 유형: 부울 기본값: false | | 케이스.위치 | 회사 위치를 설명하는 기록의 Sys_id입니다. 위치 \[cmn_location\] 테이블에 있습니다. 데이터 유형: 문자열 | | cases.made_sla | 케이스가 관련 서비스 수준 계약에 따라 해결되었는지 여부를 나타내는 플래그입니다. 가능한 값: * True: SLA에 따라 케이스가 해결됨 * false: SLA에 따라 케이스가 해결되지 않았습니다. 데이터 유형: 부울 기본값: true | | cases.major_case_state | 중요 케이스의 현재 상태입니다. 가능한 값: * 수락됨: 관리자가 중요 케이스를 만들거나 관리자가 후보 케이스를 승격할 때의 초기 상태입니다. * canceled: 케이스가 취소됩니다. * 제안됨: 에이전트 또는 관리자가 후보 케이스를 만들거나 제안하는 초기 상태입니다. * 거부됨: 관리자가 후보 케이스를 거부했습니다. 데이터 유형: 문자열 최대 길이: 40 | | needs_attention | 케이스에 주의가 필요한지 여부를 나타내는 플래그입니다. 가능한 값: * true: 케이스에 추가 주의가 필요함 * false: 케이스에 추가 주의가 필요하지 않습니다. 데이터 유형: 부울 기본값: false | | cases.notes_to_comments | 피드백에 해결 메모를 추가할지 여부를 나타내는 플래그입니다. 가능한 값: * true: 결의안 메모가 추가되면 의견에도 추가됩니다. * false: 설명의 해결 메모가 필요하지 않습니다. 데이터 유형: 부울 | | 케이스.알림 | 접촉 창구/소비자에게 알리는 데 사용할 방법입니다. 가능한 값: * 1: 알리지 않음 * 2: 이메일 보내기 * 3: 전화 데이터 형식: 숫자(정수) 기본값: 1 | | 케이스.번호 | 케이스 번호입니다. 데이터 유형: 문자열 최대 길이: 40 | | cases.opened_at | 케이스가 열린 날짜 및 시간입니다. 데이터 유형: 문자열 | | cases.opened_by | 케이스를 처음 연 사람의 Sys_id입니다. 사용자 \[sys_user\] 테이블에 있습니다. 데이터 유형: 문자열 | | 케이스.순서 | 케이스의 순서입니다. 데이터 형식: 숫자(정수) | | 케이스.상위 | 이 케이스(하위)가 연결된 상위 케이스의 Sys_id입니다. 작업 \[task\] 테이블에 있습니다. 데이터 유형: 문자열 | | 케이스.파트너 | 케이스와 연결된 파트너의 Sys_id입니다. 계정 \[customer_account\] 테이블에 있습니다. 데이터 유형: 문자열 | | cases.partner_contact | 케이스와 연결된 파트너 접촉 창구의 Sys_id입니다. 연락처 \[customer_contact\] 테이블에 있습니다. 데이터 유형: 문자열 | | 케이스.우선순위 | 케이스의 우선순위입니다. 가능한 값: * 1: 심각 * 2: 높음 * 3: 보통 * 4: 낮음 데이터 형식: 숫자(정수) 기본값: 4 | | 케이스.사전 예방적 | 문의가 사전 예방적으로 모니터링되는지 여부를 나타내는 플래그입니다. 가능한 값: * true: 사전 모니터링됩니다. * false: 모니터링되지 않습니다. 데이터 유형: 부울 기본값: false | | cases.probable_cause | 케이스와 관련된 문제의 가능한 원인입니다. 데이터 유형: 문자열 최대 길이: 4,000 | | 케이스.문제 | 고객에게 발생한 문제의 Sys_id입니다. 문제 \[problem\] 테이블에 있습니다. 데이터 유형: 문자열 | | 케이스.제품 | 케이스에 연결된 자산의 제품 모델 Sys_id입니다. 제품 모델 \[cmdb_model\] 테이블에 있습니다. 모델은 자산의 특정 버전 또는 구성입니다(예: Apple Mac Book Pro). 데이터 유형: 문자열 | | cases.reassignment_count | 케이스를 진행해야 하는 사람에게 케이스가 재할당된 횟수입니다. 데이터 형식: 숫자(정수) 기본값: 0 | | cases.recipient_list | 이 케이스에 대한 통신의 수신자 목록이 포함된 기록의 Sys_id입니다. 수신자 목록 \[sn_publications_recipients_list\] 테이블에 있습니다. 데이터 유형: 문자열 | | cases.rejection_goto | 케이스가 거부될 경우 실행할 작업 Sys_id입니다. 작업 \[task\] 테이블에 있습니다. 데이터 유형: 문자열 | | cases.resolution_code | 케이스의 해결 상태(예: "해결됨 - 제공된 지원/지침에 따라 수정")입니다. 데이터 유형: 문자열 최대 길이: 40 | | cases.resolved_at | 케이스가 해결된 날짜 및 시간입니다. 데이터 유형: 문자열 | | cases.resolved_by | 케이스를 해결한 사람의 Sys_id입니다. 사용자 \[sys_user\] 테이블에 있습니다. 데이터 유형: 문자열 | | cases.route_reason | 케이스가 다른 담당자에게 라우팅된 이유입니다. 데이터 형식: 숫자(정수) 최대 길이: 40 | | cases.service_offering | 지불 문의와 연결된 서비스 오퍼링의 Sys_id입니다. 서비스 오퍼링은 가용성, 범위, 가격 및 패키징 옵션 측면에서 서비스 수준을 고유하게 정의합니다. 서비스 오퍼링 \[service_offering\] 테이블에 있습니다. 데이터 유형: 문자열 | | cases.short_description | 케이스에 대한 간결한 설명입니다. 데이터 유형: 문자열 최대 길이: 160 | | 케이스.기술 | 케이스를 완료하는 데 필요한 기술의 고유 식별자(sys_id) 목록입니다. 기술 \[cmn_skill\] 테이블에 있습니다. 데이터 유형: 문자열 | | cases.sla_due | 연결된 서비스 수준 계약에 따라 케이스를 종결해야 하는 날짜/시간입니다. 데이터 유형: 문자열 | | cases.sn_app_cs_social_social_profile | 케이스와 연결된 소셜 미디어 프로파일의 Sys_id입니다. 소셜 프로필 \[sn_app_cs_social_social_profile\] 테이블에 있습니다. 데이터 유형: 문자열 | | cases.sold_product | 연결된 제품의 Sys_id입니다. 판매된 제품 \[sn_install_base_sold_product\] 테이블에 위치합니다. 데이터 유형: 문자열 | | 케이스.스테이지 | 완료 종결, 거부 종결, 문서 검사, 인증 등과 같은 문의 단계입니다. 데이터 유형: 문자열 최대 길이: 40 | | 케이스.상태 | 케이스의 현재 상태입니다. 가능한 값: * 1: 새로 만들기 * 3: 닫힘 * 6: 해결됨 * 10: 열기 * 18 : 정보 대기 중 데이터 형식: 숫자(정수) 기본값: 1 | | 케이스.하위 범주 | 케이스 하위 범주입니다. 가능한 값: 0: 질문 데이터 형식: 숫자(정수) 기본값: 0 | | cases.support_manager | 케이스에 할당된 CSM 관리자의 Sys_id입니다. 사용자 \[sys_user\] 테이블에 있습니다. 데이터 유형: 문자열 | | cases.sync_driver | 드라이버 동기화가 있는지 여부를 나타내는 플래그입니다. 가능한 값: * true: 드라이버가 동기화됩니다. * false: 드라이버가 동기화되지 않았습니다. 데이터 유형: 부울 | | cases.sys_클래스_이름 | 케이스 기록이 포함된 테이블입니다. 데이터 유형: 문자열 최대 길이: 80 | | cases.sys_도메인 | 케이스와 연결된 도메인입니다. 데이터 유형: 문자열 최대 길이: 32 기본값: 전역 | | cases.sys_도메인_경로 | 도메인 경로입니다. 데이터 유형: 문자열 최대 길이: 255 기본값:/ | | cases.sys_id | 케이스의 고유 식별자입니다. 데이터 유형: 문자열 최대 길이: 32 | | cases.task_effective_number | 식별 번호. 작업에 범용 요청과 연결된 경우 이는 UR 번호입니다. 그렇지 않으면 현재 작업 번호입니다. 데이터 유형: 문자열 최대 길이: 40 | | cases.time_worked | 케이스에 대해 작업한 총 시간입니다. 데이터 유형: 문자열 | | cases.universal_request | 이 문의가 속한 범용 작업의 Sys_id입니다. 작업 \[task\] 테이블에 있습니다. 데이터 유형: 문자열 | | cases.upon_approval | 케이스가 승인될 경우 수행할 동작입니다. 가능한 값: * do_nothing * 진행 데이터 유형: 문자열 최대 길이: 40 기본값: 진행 | | cases.upon_reject | 케이스가 거부될 경우 수행할 동작입니다. 가능한 값: * cancel * goto 데이터 유형: 문자열 최대 길이: 40 기본값: 취소 | | 케이스.긴급도 | 케이스의 긴급도입니다. 가능한 값: * 1: 높음 * 2: 중간 * 3: 낮음 데이터 형식: 숫자(정수) 기본값: 3 | | cases.user_input | 추가 사용자 입력. 데이터 유형: 문자열 최대 길이: 4,000 | | 케이스.변수 | 케이스와 연결된 변수의 이름-값 쌍입니다. 데이터 유형: 문자열 최대 길이: 40 | | cases.watch_list | 추가 코멘트가 추가되거나 케이스의 상태가 해결됨 또는 종결됨으로 변경될 경우 이 케이스에 대한 알림을 받는 사용자의 sys_ids 목록입니다. 사용자 \[sys_user\] 테이블에 있습니다. 데이터 유형: 배열 | | cases.wf_activity | 케이스와 연결된 워크플로우 활동 기록의 Sys_id입니다. 워크플로우 활동 \[wf_activity\] 테이블에 있습니다. 데이터 유형: 문자열 | | cases.work_end | 케이스에 대한 작업이 종료된 날짜 및 시간입니다. 데이터 유형: 문자열 | | cases.work_notes | 케이스를 해결하는 방법 또는 해결을 위해 수행한 단계에 대한 정보입니다. 데이터 유형: 문자열 최대 길이: 4,000 | | cases.work_notes_list | 작업 메모가 추가될 때 이 케이스에 대한 알림을 받는 내부 사용자의 sys_ids 목록입니다. 사용자 \[sys_user\] 테이블에 있습니다. 데이터 유형: 배열 | | cases.work_start | 케이스에 대한 작업이 시작된 날짜 및 시간입니다. 데이터 유형: 문자열 | | has_more | 테이블에 반환할 기록이 더 있는지 여부를 나타내는 플래그입니다. 가능한 값: * true: 반환할 레코드가 더 많습니다. * false: 더 이상 반환할 기록이 없습니다. 데이터 형식: 부울 문자열 | | 상태 | 엔드포인트 호출의 상태입니다. 데이터 유형: 문자열 | | sysparm_limit | 반환할 최대 기록 수입니다. 이 기록 수를 초과하는 요청의 경우 sysparm_offset 매개변수를 사용하여 기록 검색을 페이지 매김합니다. 응답에서 boolean 매개 변수가 hasMore 반환됩니다. 필터 기준을 충족하는 반환할 기록이 더 있는지 여부를 나타냅니다. 데이터 유형: 숫자 기본값: 10 | | sysparm_offset | 기록 검색을 시작할 시작 기록 인덱스입니다. 이 값을 사용하여 기록 검색을 페이지 매김합니다. 이 기능을 사용하면 기록 수와 관계없이 관리 가능한 작은 청크로 모든 기록을 검색할 수 있습니다. 예를 들어 이 엔드포인트를 처음 호출할 때 sysparm_offset이 "0"으로 설정됩니다. 사용 가능한 모든 기록을 간단히 살펴보려면 모든 기록이 끝날 때까지 `sysparm_offset=sysparm_offset+sysparm_limit`를 사용합니다. sysparm_offset 매개변수에 음수를 전달하지 마십시오. 데이터 유형: 숫자 기본값: 0 | [ ] ### cURL 요청 다음 코드 예제에서는 이 끝점을 호출하는 방법을 보여 줍니다. curl "https://instance.servicenow.com/api/sn_install_base/integrations/installbaseitems/1474a3c853500010df5dddeeff7b12ec/cases" \ --request GET \ --header "Accept:application/json" \ --user 'username':'password' 반환 결과: { "result": { "sysparm_offset": 0, "sysparm_limit": 10, "has_more": false, "cases": [ { "upon_reject": { "value": "cancel", "display_value": "Cancel all future Tasks" }, "number": "CS0001034", "initiated_as_request": "0", "state": "1", "case": "Performance is impacted with latest update​CS0001034", "knowledge": "0", "impact": "3", "contract": { "sys_id": "495e16b96f0731003b3c498f5d3ee4af", "display_value": "CNTR0000603" }, "active": "1", "auto_created_case": "0", "priority": "4", "sys_domain_path": "/", "child_case_creation_progress": "0", "sync_driver": "0", "needs_attention": "0", "short_description": "Performance is impacted with latest update", "notify": "1", "sys_class_name": "sn_customerservice_case", "reassignment_count": "0", "notes_to_comments": "0", "hierarchical_variables": "variable_pool", "escalation": "0", "upon_approval": { "value": "proceed", "display_value": "Proceed to Next Task" }, "made_sla": "1", "task_effective_number": "CS0001034", "opened_by": { "sys_id": "ddce70866f9331003b3c498f5d3ee417", "display_value": "George Warren" }, "contact": { "sys_id": "ddce70866f9331003b3c498f5d3ee417", "display_value": "George Warren" }, "follow_the_sun": "0", "entitlement": { "sys_id": "1eb7893a6f1b31003b3c498f5d3ee4dd", "display_value": "24x7 Customer Support" }, "opened_at": { "value": "2023-03-20 14:53:51", "display_value": "2023-03-20 07:53:51" }, "case_report": { "sys_id": "85e8604c87f521100b6afc86dabb35b9", "display_value": "CSR0010014" }, "subcategory": "0", "install_base": { "sys_id": "1474a3c853500010df5dddeeff7b12ec", "display_value": "Boxeo - Development" }, "proactive": "0", "auto_close": "0", "sys_id": "92c8684087b521105d0055373cbb357e", "contact_type": { "value": "web", "display_value": "Web" }, "urgency": "3", "approval": { "value": "not requested", "display_value": "Not Yet Requested" }, "category": "1", "account": { "sys_id": "86837a386f0331003b3c498f5d3ee4ca", "display_value": "Boxeo" } }, { "upon_reject": { "value": "cancel", "display_value": "Cancel all future Tasks" }, "number": "CS0001008", "initiated_as_request": "0", "state": "1", "case": "Test Alert​CS0001008", "knowledge": "0", "impact": "3", "active": "1", "auto_created_case": "0", "priority": "1", "sys_domain_path": "/", "child_case_creation_progress": "0", "sync_driver": "0", "needs_attention": "1", "short_description": "Test Alert", "notify": "1", "sys_class_name": "sn_customerservice_case", "reassignment_count": "0", "notes_to_comments": "0", "hierarchical_variables": "variable_pool", "escalation": "0", "upon_approval": { "value": "proceed", "display_value": "Proceed to Next Task" }, "made_sla": "1", "task_effective_number": "CS0001008", "opened_by": { "sys_id": "08c83021acbe7300964fca436af2bb97", "display_value": "noc_operator " }, "follow_the_sun": "0", "opened_at": { "value": "2023-03-15 08:02:58", "display_value": "2023-03-15 01:02:58" }, "case_report": { "sys_id": "a4fa9d9a872d61105d0055373cbb356e", "display_value": "CSR0010005" }, "subcategory": "0", "proactive": "1", "auto_close": "0", "sys_id": "60ea199a872d61105d0055373cbb35c9", "contact_type": { "value": "proactive", "display_value": "Alert" }, "alert": { "sys_id": "506a559a872d61105d0055373cbb3581", "display_value": "Alert0010008" }, "urgency": "3", "action_status": "4", "approval": { "value": "not requested", "display_value": "Not Yet Requested" }, "category": "1" }, { "upon_reject": { "value": "cancel", "display_value": "Cancel all future Tasks" }, "number": "CS0001033", "initiated_as_request": "0", "state": "1", "case": "System is down​CS0001033", "knowledge": "0", "impact": "3", "contract": { "sys_id": "495e16b96f0731003b3c498f5d3ee4af", "display_value": "CNTR0000603" }, "active": "1", "auto_created_case": "0", "priority": "4", "sys_domain_path": "/", "child_case_creation_progress": "0", "sync_driver": "0", "needs_attention": "0", "short_description": "System is down", "notify": "1", "sys_class_name": "sn_customerservice_case", "reassignment_count": "0", "notes_to_comments": "0", "hierarchical_variables": "variable_pool", "escalation": "0", "upon_approval": { "value": "proceed", "display_value": "Proceed to Next Task" }, "made_sla": "1", "task_effective_number": "CS0001033", "opened_by": { "sys_id": "ddce70866f9331003b3c498f5d3ee417", "display_value": "George Warren" }, "contact": { "sys_id": "ddce70866f9331003b3c498f5d3ee417", "display_value": "George Warren" }, "follow_the_sun": "0", "entitlement": { "sys_id": "1eb7893a6f1b31003b3c498f5d3ee4dd", "display_value": "24x7 Customer Support" }, "opened_at": { "value": "2023-03-20 14:52:48", "display_value": "2023-03-20 07:52:48" }, "case_report": { "sys_id": "64b86c0c87f521100b6afc86dabb35fc", "display_value": "CSR0010013" }, "subcategory": "0", "install_base": { "sys_id": "1474a3c853500010df5dddeeff7b12ec", "display_value": "Boxeo - Development" }, "proactive": "0", "auto_close": "0", "sys_id": "7c98a04087b521105d0055373cbb352e", "contact_type": { "value": "web", "display_value": "Web" }, "urgency": "3", "approval": { "value": "not requested", "display_value": "Not Yet Requested" }, "category": "1", "account": { "sys_id": "86837a386f0331003b3c498f5d3ee4ca", "display_value": "Boxeo" } }, { "upon_reject": { "value": "cancel", "display_value": "Cancel all future Tasks" }, "number": "CS0001048", "initiated_as_request": "0", "state": "1", "case": "AIB with Single account​CS0001048", "knowledge": "0", "impact": "3", "active": "1", "auto_created_case": "0", "priority": "4", "sys_domain_path": "/", "child_case_creation_progress": "0", "sync_driver": "0", "needs_attention": "1", "short_description": "AIB with Single account", "notify": "1", "sys_class_name": "sn_customerservice_case", "reassignment_count": "0", "notes_to_comments": "0", "hierarchical_variables": "variable_pool", "escalation": "0", "upon_approval": { "value": "proceed", "display_value": "Proceed to Next Task" }, "made_sla": "1", "task_effective_number": "CS0001048", "opened_by": { "sys_id": "08c83021acbe7300964fca436af2bb97", "display_value": "noc_operator " }, "contact": { "sys_id": "4d147a386f0331003b3c498f5d3ee437", "display_value": "Julie Lewis" }, "follow_the_sun": "0", "opened_at": { "value": "2023-03-24 03:28:58", "display_value": "2023-03-23 20:28:58" }, "case_report": { "sys_id": "4082be81877161100b6afc86dabb35fe", "display_value": "CSR0010023" }, "subcategory": "0", "proactive": "1", "auto_close": "0", "sys_id": "6a723e81877161100b6afc86dabb35cf", "contact_type": { "value": "proactive", "display_value": "Alert" }, "alert": { "sys_id": "6b227681877161100b6afc86dabb35d5", "display_value": "Alert0010094" }, "urgency": "3", "action_status": "4", "approval": { "value": "not requested", "display_value": "Not Yet Requested" }, "category": "1", "account": { "sys_id": "86837a386f0331003b3c498f5d3ee4ca", "display_value": "Boxeo" } } ], "status": "SUCCESS" } } ## 설치 기반 항목 - GET /sn_install_base/integrations/installbaseitems/{id}/childinstallbaseitems {#ariaid-title6} 지정된 설치 기반 항목 기록과 연결된 하위 설치 기반 항목을 반환합니다.
### URL 형식 버전이 지정된 URL: /api/sn_install_base/{api_version}/integrations/installbaseitems/{id}/childinstallbaseitems 기본 URL: /api/sn_install_base/integrations/installbaseitems/{id}/childinstallbaseitems ### 지원되는 요청 매개변수 {#integrat-GET-childinstallitems__entry__2}{#integrat-GET-childinstallitems__version-RESTAPI}{#integrat-GET-childinstallitems__integrate-id-entry} | 이름 | 설명 | |-|-| | api_version | 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열 | | id | 설치 기반 항목 기록의 Sys_id입니다. 설치 기반 항목 \[sn_install_base_item\] 테이블에 있습니다. 데이터 유형: 문자열 | [표 25. 경로 매개변수] {#integrat-GET-childinstallitems__entry__8}{#integrat-GET-childinstallitems__sysparm-limit-RESTAPI}{#integrat-GET-childinstallitems__sysparm_offset-ph-RESTAPI} | 이름 | 설명 | |-|-| | 필드 이름-값 쌍 | 하위 설치 기반 항목 기록을 필터링하는 데 사용할 필드 값 쌍입니다. 설치 기반 항목 \[sn_install_base_item\] 테이블에 있습니다. 에서 sys_class_name다른 테이블을 지정하는 경우 해당 테이블의 필드를 지정합니다. 하나 이상의 필드-값 쌍을 전달하여 반환 결과를 필터링할 수 있습니다. 예를 들어 상태 필드가 "in_use"로 설정되고 상태 필드가 "교체"로 설정된 기록만 반환하려면 `&state=in_use&status=replacement`를 전달합니다. 데이터 유형: 문자열 기본값: 모든 필드 | | sys_class_name | 확장된 설치 기반 항목 테이블(sn_install_base_item 아님)을 사용하는 경우 쿼리할 확장된 테이블의 이름입니다. 데이터 유형: 문자열 기본값: sn_install_base_item | | sysparm_limit | 반환할 최대 기록 수입니다. 이 기록 수를 초과하는 요청의 경우 sysparm_offset 매개변수를 사용하여 기록 검색을 페이지 매김합니다. 이 제한은 ACL 평가 전에 적용됩니다. 액세스할 수 있는 기록을 포함하여 반환되는 기록이 없으면 액세스할 수 있는 기록이 먼저 반환되도록 기록 순서를 다시 정렬합니다. 주: 이례적으로 큰 sysparm_limit 값은 시스템 성능에 영향을 미칠 수 있습니다. 데이터 유형: 숫자 기본값: 10000 | | sysparm_offset | 기록 검색을 시작할 시작 기록 인덱스입니다. 이 값을 사용하여 기록 검색을 페이지 매김합니다. 이 기능을 사용하면 기록 수와 관계없이 관리 가능한 작은 청크로 모든 기록을 검색할 수 있습니다. 예를 들어 이 엔드포인트를 처음 호출할 때 sysparm_offset이 "0"으로 설정됩니다. 사용 가능한 모든 기록을 간단히 살펴보려면 모든 기록이 끝날 때까지 `sysparm_offset=sysparm_offset+sysparm_limit`를 사용합니다.{#integrat-GET-childinstallitems__sysparm_offset-p-RESTAPI} 매개 변수에 sysparm_offset 음수를 전달하지 마세요. 데이터 유형: 숫자 기본값: 0 | [표 26. 쿼리 매개변수] {#integrat-GET-childinstallitems__entry__18} | 이름 | 설명 | |-|-| | 없음 | | [표 27. 요청 본문 매개변수(XML 또는 JSON)] ### 헤더 다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 [지원되는 REST API 헤더를](https://servicenow-prod.fluidtopics.net/JHL64oGR2SkU25ZTkfHy7g "REST(REpresentational State Transfer)는 웹상의 컴퓨터 시스템 간에 표준을 제공하여 서로 보다 쉽게 통신할 수 있게 지원하는 단순한 상태 비저장 아키텍처입니다.") 참조하세요. {#integrat-GET-childinstallitems__entry__22}{#integrat-GET-childinstallitems__accept-RESTAPI} | 헤더 | 설명 | |-|-| | 수용 | 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json | [표 28. 요청 헤더] {#integrat-GET-childinstallitems__entry__26} | 헤더 | 설명 | |-|-| | 없음 | | [표 29. 응답 헤더] ### 상태 코드 다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 [REST API HTTP 응답 코드를](https://servicenow-prod.fluidtopics.net/JHL64oGR2SkU25ZTkfHy7g "REST(REpresentational State Transfer)는 웹상의 컴퓨터 시스템 간에 표준을 제공하여 서로 보다 쉽게 통신할 수 있게 지원하는 단순한 상태 비저장 아키텍처입니다.") 참조하세요. {#integrat-GET-childinstallitems__entry__30}{#integrat-GET-childinstallitems__entry-200-status-code}{#integrat-GET-childinstallitems__entry-400-status-code}{#integrat-GET-childinstallitems__entry-403-status-code}{#integrat-GET-childinstallitems__entry-404-status-code}{#integrat-GET-childinstallitems__entry-500-status-code} | 상태 코드 | 설명 | |-|-| | 200 | 성공입니다. 요청이 성공적으로 처리되었습니다. | | 400 | 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다. | | 403 | 금지되었습니다. 사용자에게 지정된 기록에 대한 액세스 권한이 없습니다. | | 404 | 찾을 수 없습니다. 요청한 항목을 찾을 수 없습니다. | | 500 | 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다. | [표 30. 상태 코드] ### 응답 본문 매개변수(JSON 또는 XML) {#integrat-GET-childinstallitems__id_qfp_hxl_xwb__entry__2}{#integrat-GET-childinstallitems__has_more-integration-entry}{#integrat-GET-childinstallitems__account-integration-entry}{#integrat-GET-childinstallitems__account_display_value-integration-entry}{#integrat-GET-childinstallitems__account_sys_id-integration-entry}{#integrat-GET-childinstallitems__active-integration-entry}{#integrat-GET-childinstallitems__asset-integration-entry}{#integrat-GET-childinstallitems__asset_display_value-integration-entry}{#integrat-GET-childinstallitems__asset_sys_id-integration-entry}{#integrat-GET-childinstallitems__configuration_item-integration-entry}{#integrat-GET-childinstallitems__configuration_item_display_value-integration-entry}{#integrat-GET-childinstallitems__configuration_item_sys_id-integration-entry}{#integrat-GET-childinstallitems__consumer-integration-entry}{#integrat-GET-childinstallitems__consumer_display_value-integration-entry}{#integrat-GET-childinstallitems__consumer_sys_id-integration-entry}{#integrat-GET-childinstallitems__consumer_profile-integration-entry}{#integrat-GET-childinstallitems__consumer_profile_display_value-integration-entry}{#integrat-GET-childinstallitems__consumer_profile_sys_id-integration-entry}{#integrat-GET-childinstallitems__contact-integration-entry}{#integrat-GET-childinstallitems__contact_display_value-integration-entry}{#integrat-GET-childinstallitems__contact_sys_id-integration-entry}{#integrat-GET-childinstallitems__health_status-integration-entry}{#integrat-GET-childinstallitems__health_status_display_value-integration-entry}{#integrat-GET-childinstallitems__health_status_value-integration-entry}{#integrat-GET-childinstallitems__health_status_last_updated-integration-entry}{#integrat-GET-childinstallitems__household-integration-entry}{#integrat-GET-childinstallitems__household_display_value-integration-entry}{#integrat-GET-childinstallitems__household_sys_id-integration-entry}{#integrat-GET-childinstallitems__install_date-integration-entry}{#integrat-GET-childinstallitems__install_date_display_value-integration-entry}{#integrat-GET-childinstallitems__install_date_value-integration-entry}{#integrat-GET-childinstallitems__location-integration-entry}{#integrat-GET-childinstallitems__location_display_value-integration-entry}{#integrat-GET-childinstallitems__location_sys_id-integration-entry}{#integrat-GET-childinstallitems__name-integration-entry}{#integrat-GET-childinstallitems__number-integration-entry}{#integrat-GET-childinstallitems__parent-integration-entry}{#integrat-GET-childinstallitems__parent_display_value-integration-entry}{#integrat-GET-childinstallitems__parent_sys_id-integration-entry}{#integrat-GET-childinstallitems__product-integration-entry}{#integrat-GET-childinstallitems__product_display_value-integration-entry}{#integrat-GET-childinstallitems__product_sys_id-integration-entry}{#integrat-GET-childinstallitems__service_context-integration-entry}{#integrat-GET-childinstallitems__service_context_display_value-integration-entry}{#integrat-GET-childinstallitems__service_context_sys_id-integration-entry}{#integrat-GET-childinstallitems__service_organization-integration-entry}{#integrat-GET-childinstallitems__service_organization_display_value-integration-entry}{#integrat-GET-childinstallitems__service_organization_sys_id-integration-entry}{#integrat-GET-childinstallitems__sys_class_name-integration-entry}{#integrat-GET-childinstallitems__sys_id-integration-entry}{#integrat-GET-childinstallitems__sys_mod_count-integration-entry}{#integrat-GET-childinstallitems__state-integration-entry}{#integrat-GET-childinstallitems__state_display_value-integration-entry}{#integrat-GET-childinstallitems__state_value-integration-entry}{#integrat-GET-childinstallitems__status1-integration-entry}{#integrat-GET-childinstallitems__status1_display_value-integration-entry}{#integrat-GET-childinstallitems__status1_value-integration-entry}{#integrat-GET-childinstallitems__uninstall_date-integration-entry}{#integrat-GET-childinstallitems__uninstall_date_display_value-integration-entry}{#integrat-GET-childinstallitems__uninstall_date_value-integration-entry}{#integrat-GET-childinstallitems__status-integration-entry}{#integrat-GET-childinstallitems__sysparm_depth-integration-entry}{#integrat-GET-childinstallitems__sysparm_limit-integration-entry}{#integrat-GET-childinstallitems__sysparm_offset-integration-entry} | 이름 | 설명 | |-|-| | 오류 | 요청을 처리하려고 할 때 발생한 오류에 대한 상세 정보입니다. 데이터 유형: 객체 "error": { "detail": "String", "message": "String" } | | 오류.상세 정보 | 관련 오류에 대한 추가 정보입니다. 데이터 유형: 문자열 | | 오류.메시지 | 요청을 실행하려고 할 때 발생한 문제를 설명하는 오류 메시지입니다. 데이터 유형: 문자열 | | has_more | 테이블에 반환할 기록이 더 있는지 여부를 나타내는 플래그입니다. 가능한 값: * true: 반환할 레코드가 더 많습니다. * false: 더 이상 반환할 기록이 없습니다. 데이터 형식: 부울 문자열 | | 항목 | 지정된 필터 결과와 일치하는 설치 기반 항목의 목록입니다. 데이터 형식: 객체 배열 "items":[ { "account": {Object}, "active": "String", "asset": {Object}, "configuration_item": {Object}, "consumer": {Object}, "consumer_profile": {Object}, "contact": {Object}, "health_status": {Object}, "health_status_last_updated": "String", "household": {Object}, "install_date": {Object}, "location": {Object}, "name": "String", "number": "String", "parent": {Object}, "product": {Object}, "service_context": {Object}, "service_organization" {Object}, "sys_class_name": "String", "sys_id": "String", "sys_mod_count": "String", "state": {Object}, "status": {Object}, "uninstall_date": "String" } ] | | items.account | 설치 기반 항목 기록과 연결된 고객 계정에 대한 세부 정보입니다. 데이터 유형: 객체 "account": { "display_value": "String", "sys_id": "String" } | | items.account.display_value | 설치 기반 항목 기록과 연결된 고객 계정의 텍스트 이름입니다. 이 값을 사용하여 UI에 고객 계정 이름을 표시합니다. 데이터 유형: 문자열 | | items.account.sys_id | 설치 기반 항목 기록과 연결된 고객 계정 기록의 Sys_id입니다. 데이터 유형: 문자열 | | items.active | 설치 기반 항목이 활성 상태인지 여부를 나타내는 플래그입니다. 가능한 값: * true: 설치 기반 항목이 활성 상태입니다. * false: 설치 기반 항목이 비활성 상태입니다. 데이터 유형: 부울 문자열 | | items.asset | 설치 기반 항목 기록과 연결된 자산에 대한 세부 정보입니다. 데이터 유형: 객체 "asset": { "display_value": "String", "sys_id": "String" } | | items.asset.display_value | 설치 기반 항목 기록과 연결된 자산의 텍스트 이름입니다. 이 값을 사용하여 UI에 자산 이름을 표시합니다. 데이터 유형: 문자열 | | items.asset.sys_id | 설치 기반 항목 기록과 연결된 자산 기록의 Sys_id입니다. 데이터 유형: 문자열 | | items.configuration_item | 설치 기반 항목 기록과 연결된 구성 항목에 대한 세부 정보입니다. 데이터 유형: 객체 "configuration_item": { "display_value": "String", "sys_id": "String" } | | items.configuration_item.display_value | 설치 기반 항목 기록과 연결된 구성 항목의 텍스트 이름입니다. 이 값을 사용하여 UI에 구성 항목 이름을 표시합니다. 데이터 유형: 문자열 | | items.configuration_item.sys_id | 설치 기반 항목 기록과 연결된 구성 항목 기록의 Sys_id입니다. 데이터 유형: 문자열 | | items.consumer | 설치 기반 항목 기록과 연결된 소비자에 대한 세부 정보입니다. 주: 소비자 필드는 B2B2C 플러그인이 설치된 경우에만 사용할 수 있습니다. 데이터 유형: 객체 "consumer": { "display_value": "String", "sys_id": "String" } | | items.consumer.display_value | 설치 기반 항목 기록과 연결된 소비자의 텍스트 이름입니다. 이 값을 사용하여 UI에 소비자 이름을 표시합니다. 데이터 유형: 문자열 | | items.consumer.sys_id | 설치 기반 항목 기록과 연결된 소비자 기록의 Sys_id입니다. 데이터 유형: 문자열 | | items.consumer_profile | 설치 기반 항목 기록과 연결된 소비자 프로필에 대한 세부 정보입니다. 주: 소비자 프로필 필드는 B2B2C 플러그인이 설치된 경우에만 사용할 수 있습니다. 데이터 유형: 객체 "consumer_profile": { "display_value": "String", "sys_id": "String" } | | items.consumer_profile.display_value | 설치 기반 항목 기록과 연결된 소비자 프로필의 텍스트 이름입니다. 이 값을 사용하여 UI에 소비자 프로파일 이름을 표시합니다. 데이터 유형: 문자열 | | items.consumer_profile.sys_id | 설치 기반 항목 기록과 연결된 소비자 프로필 기록의 Sys_id입니다. 데이터 유형: 문자열 | | items.contact | 설치 기반 항목 기록을 담당하는 계정 접촉 창구에 대한 세부 정보입니다. 데이터 유형: 객체 "contact": { "display_value": "String", "sys_id": "String" } | | items.contact.display_value | 설치 기반 항목 기록과 연결된 계정 연락처의 텍스트 이름입니다. 이 값을 사용하여 UI에 계정 접촉 창구 이름을 표시합니다. 데이터 유형: 문자열 | | items.contact.sys_id | 설치 기반 항목 기록과 연결된 계정 연락처 기록의 Sys_id입니다. 데이터 유형: 문자열 | | items.health_status | 설치 기반 항목의 현재 상태에 대한 세부 정보입니다. com.snc.proactive_cs_itom(사전 예방적 고객 서비스 운영) 플러그인이 설치된 경우에만 반환됩니다. 데이터 유형: 객체 "health_status": { "display_value": "String", "value": "String" } | | items.health_status.display_value | 설치 기반 항목의 현재 상태를 나타내는 텍스트 문자열입니다. 이 값을 사용하여 UI에 상태를 표시합니다. 데이터 유형: 문자열 | | items.health_status.value | 설치 기반 항목의 상태에 대한 내부 값입니다. 데이터 유형: 문자열 | | items.health_status_last_updated | 설치 기반 항목의 상태가 마지막으로 업데이트된 날짜 및 시간입니다. 데이터 유형: 문자열 | | items.household | 설치 기반 항목 기록과 연결된 세대에 대한 세부 정보입니다. Customer Service Household(com.snc.household) 플러그인이 설치된 경우에만 반환됩니다. 데이터 유형: 객체 "household": { "display_value": "String", "sys_id": "String" } | | items.household.display_value | 설치 기반 항목 기록과 연결된 세대의 텍스트 이름입니다. 이 값을 사용하여 UI에 세대 이름을 표시합니다. 데이터 유형: 문자열 | | items.household.sys_id | 설치 기반 항목 기록과 연결된 세대 Sys_id입니다. 데이터 유형: 문자열 | | items.install_date | 설치 기반 항목이 활성화된 날짜에 대한 세부 정보입니다. 데이터 유형: 객체 "install_date": { "display_value": "String", "value": "String" } | | items.install_date.display_value | 텍스트 설치 날짜입니다. 이 값을 사용하여 UI에 설치 날짜를 표시합니다. 데이터 유형: 문자열 | | items.install_date.value | 설치 날짜의 내부 값입니다. 데이터 유형: 문자열 | | items.location | 설치 기반 항목의 위치에 대한 세부 정보입니다. 데이터 유형: 객체 "location": { "display_value": "String", "sys_id": "String" } | | items.location.display_value | 설치 기반 항목 위치의 텍스트 이름입니다. 이 값을 사용하여 UI에 위치 이름을 표시합니다. 데이터 유형: 문자열 | | items.location.sys_id | 설치 기반 항목 기록과 연결된 위치 기록의 Sys_id입니다. 데이터 유형: 문자열 | | items.name | 설치 기반 항목의 이름입니다. 데이터 유형: 문자열 | | items.number | 설치 기반 항목의 고유 ID입니다. 데이터 유형: 문자열 | | items.parent | 설치 기반 항목 기록의 상위 기록에 대한 세부 정보입니다. 데이터 유형: 객체 "parent": { "display_value": "String", "sys_id": "String" } | | items.parent.display_value | 설치 기반 항목 기록과 연결된 상위 기록의 텍스트 이름입니다. 이 값을 사용하여 UI에 상위 이름을 표시합니다. 데이터 유형: 문자열 | | items.parent.sys_id | 설치 기반 항목 기록과 연결된 상위 기록의 Sys_id입니다. 데이터 유형: 문자열 | | items.product | 설치 기반 항목 기록과 연결된 제품 모델에 대한 세부 정보입니다. 이 정보를 사용하여 제품 모델과 연결된 서비스를 식별합니다. 데이터 유형: 객체 "product": { "display_value": "String", "sys_id": "String" } | | items.product.display_value | 설치 기반 항목 기록과 연결된 제품 모델의 텍스트 이름입니다. 이 값을 사용하여 UI에 제품 이름을 표시합니다. 데이터 유형: 문자열 | | items.product.sys_id | 설치 기반 항목 기록과 연결된 제품 모델 기록의 Sys_id입니다. 데이터 유형: 문자열 | | items.service_context | 설치 기반 항목 기록과 연결된 서비스 컨텍스트에 대한 상세 정보입니다. 데이터 유형: 객체 "service_context": { "display_value": "String", "sys_id": "String" } | | items.service_context.display_value | 설치 기반 항목 기록과 연결된 서비스 컨텍스트의 텍스트 이름입니다. 이 값을 사용하여 UI에 서비스 컨텍스트 이름을 표시합니다. 데이터 유형: 문자열 | | items.service_context.sys_id | 설치 기반 항목 기록과 연결된 서비스 컨텍스트 기록의 Sys_id입니다. 데이터 유형: 문자열 | | items.service_organization | 설치 기반 항목 기록과 연결된 서비스 조직에 대한 세부 정보입니다. Service Organization(com.snc.service_organization) 플러그인이 설치된 경우에만 반환됩니다. 데이터 유형: 객체 "service_organization": { "display_value": "String", "sys_id": "String" } | | items.service_organization.display_value | 설치 기반 항목 기록과 연결된 서비스 조직의 텍스트 이름입니다. 이 값을 사용하여 UI에 서비스 조직 이름을 표시합니다. 데이터 유형: 문자열 | | items.service_organization.sys_id | 설치 기반 항목 기록과 연결된 서비스 조직 기록의 Sys_id입니다. 데이터 유형: 문자열 | | items.sys_클래스_이름 | 설치 기반 항목 기록을 포함하는 테이블입니다. 데이터 유형: 문자열 | | items.sys_id | 설치 기반 항목 기록의 Sys_id입니다. 매개변수에 지정된 sys_class_name 테이블에 있습니다. 데이터 유형: 문자열 | | items.sys_mod_count | 연결된 설치 기반 항목 기록이 수정된 횟수입니다. 데이터 유형: 문자열 | | items.state | 설치 기반 항목의 현재 상태에 대한 세부 정보입니다. 데이터 유형: 객체 "state": { "display_value": "String", "value": "String" } | | items.state.display_value | 설치 기반 항목의 현재 상태에 대한 텍스트 문자열입니다. 이 값을 사용하여 UI에 상태를 표시합니다. 데이터 유형: 문자열 | | items.state.value | 설치 기반 항목의 상태에 대한 내부 값입니다. 데이터 유형: 문자열 | | items.status | 설치 기반 항목의 상태에 대한 세부 정보입니다. 데이터 유형: 객체 "status": { "display_value": "String", "value": "String" } | | items.status.display_value | 설치 기반 항목의 상태에 대한 텍스트 문자열입니다. 이 값을 사용하여 UI에 상태를 표시합니다. 데이터 유형: 문자열 | | items.status.value | 설치 기반 항목의 상태에 대한 내부 값입니다. 데이터 유형: 문자열 | | items.uninstall_date | 설치 기반 항목이 비활성 상태가 된 날짜에 대한 세부 정보입니다. 데이터 유형: 객체 "uninstall_date": { "display_value": "String", "value": "String" } | | items.uninstall_date.display_value | 텍스트 제거 날짜. 이 값을 사용하여 UI에 제거 날짜를 표시합니다. 데이터 유형: 문자열 | | items.uninstall_date.값 | 제거 날짜의 내부 값입니다. 데이터 유형: 문자열 | | 상태 | 엔드포인트 호출의 상태입니다. 데이터 유형: 문자열 | | sysparm_depth | 계층 구조에서 반환되는 하위 설치 기반 항목의 수준 깊이의 수입니다. 데이터 형식: 정수 | | sysparm_limit | 반환된 기록 수입니다. 이 값이 원래 요청에 지정되지 않은 경우 기본값이 사용됩니다. 데이터 유형: 숫자 | | sysparm_offset | 기록이 평가 및 검색된 관련 테이블의 오프셋(시작 지점)입니다. 데이터 유형: 문자열 | [ ] {#integrat-GET-childinstallitems__id_qfp_hxl_xwb} ### cURL 요청 다음 코드 예제에서는 이 끝점을 호출하는 방법을 보여 줍니다. curl "https://instance.servicenow.com/api/sn_install_base/integrations/installbaseitems/767f34d378d21110f877d304c76fdd2a/childinstallbaseitems?sysparm_limit=1" \ --request GET \ --header "Accept:application/json" \ --user 'username':'password' 반환 결과: { "result": { "sysparm_offset": 0, "sysparm_limit": 1, "has_more": true, "items": [ { "parent": { "sys_id": "767f34d378d21110f877d304c76fdd2a", "display_value": "X5 Sport Utility 4D" }, "sys_class_name": "sn_install_base_item", "number": "IBITM0001005", "sys_id": "0704dfcc39265110f87734024cfbc222", "state": { "value": "in_use", "display_value": "In Use" }, "consumer": { "sys_id": "bab5139ab3401010700b4d43c6a8dc41", "display_value": "Charles Barkley" }, "product": { "sys_id": "56c84f0439265110f87734024cfbc233", "display_value": "Electric Power-Assist Speed-Sensing Steering" }, "active": "true", "name": "Electric Power-Assist Speed-Sensing Steering", "status": { "value": "original", "display_value": "Original" } } ], "status": "SUCCESS" } } ## 설치 기반 항목 - GET /sn_install_base/integrations/installbaseitems/{id}/contracts {#ariaid-title7} 지정된 설치 기반 항목 기록과 연결된 계약을 반환합니다.
### URL 형식 버전이 지정된 URL: /api/sn_install_base/{api_version}/integrations/installbaseitems/{id}/contracts 기본 URL: /api/sn_install_base/integrations/installbaseitems/{id}/contracts ### 지원되는 요청 매개변수 {#integrat-GET-contracts__entry__2}{#integrat-GET-contracts__version-RESTAPI}{#integrat-GET-contracts__integrate-id-entry} | 이름 | 설명 | |-|-| | api_version | 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열 | | id | 설치 기반 항목 기록의 Sys_id입니다. 설치 기반 항목 \[sn_install_base_item\] 테이블에 있습니다. 데이터 유형: 문자열 | [표 31. 경로 매개변수] {#integrat-GET-contracts__entry__8}{#integrat-GET-contracts__sysparm-limit-RESTAPI}{#integrat-GET-contracts__sysparm_offset-ph-RESTAPI} | 이름 | 설명 | |-|-| | 필드 이름-값 쌍 | 계약 기록을 필터링하는 데 사용할 필드-값 쌍입니다. 기본적으로 계약 \[ast_contract\] 테이블의 필드를 참조합니다. 에서 sys_class_name다른 테이블을 지정하는 경우 해당 테이블의 필드를 지정합니다. 하나 이상의 필드-값 쌍을 전달하여 반환 결과를 필터링할 수 있습니다. 예를 들어 갱신 가능 필드가 "true"로 설정된 레코드만 반환하려면 `&renewable=true`를 전달합니다. 데이터 유형: 문자열 기본값: 모든 필드 | | sys_class_name | 확장 계약 테이블(ast_contract 아님)을 사용하는 경우 쿼리할 확장 테이블의 이름입니다. 데이터 유형: 문자열 기본값: ast_contract | | sysparm_limit | 반환할 최대 기록 수입니다. 이 기록 수를 초과하는 요청의 경우 sysparm_offset 매개변수를 사용하여 기록 검색을 페이지 매김합니다. 이 제한은 ACL 평가 전에 적용됩니다. 액세스할 수 있는 기록을 포함하여 반환되는 기록이 없으면 액세스할 수 있는 기록이 먼저 반환되도록 기록 순서를 다시 정렬합니다. 주: 이례적으로 큰 sysparm_limit 값은 시스템 성능에 영향을 미칠 수 있습니다. 데이터 유형: 숫자 기본값: 10000 | | sysparm_offset | 기록 검색을 시작할 시작 기록 인덱스입니다. 이 값을 사용하여 기록 검색을 페이지 매김합니다. 이 기능을 사용하면 기록 수와 관계없이 관리 가능한 작은 청크로 모든 기록을 검색할 수 있습니다. 예를 들어 이 엔드포인트를 처음 호출할 때 sysparm_offset이 "0"으로 설정됩니다. 사용 가능한 모든 기록을 간단히 살펴보려면 모든 기록이 끝날 때까지 `sysparm_offset=sysparm_offset+sysparm_limit`를 사용합니다.{#integrat-GET-contracts__sysparm_offset-p-RESTAPI} 매개 변수에 sysparm_offset 음수를 전달하지 마세요. 데이터 유형: 숫자 기본값: 0 | [표 32. 쿼리 매개변수] {#integrat-GET-contracts__entry__18} | 이름 | 설명 | |-|-| | 없음 | | [표 33. 요청 본문 매개변수(XML 또는 JSON)] ### 헤더 다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 [지원되는 REST API 헤더를](https://servicenow-prod.fluidtopics.net/JHL64oGR2SkU25ZTkfHy7g "REST(REpresentational State Transfer)는 웹상의 컴퓨터 시스템 간에 표준을 제공하여 서로 보다 쉽게 통신할 수 있게 지원하는 단순한 상태 비저장 아키텍처입니다.") 참조하세요. {#integrat-GET-contracts__entry__22}{#integrat-GET-contracts__accept-RESTAPI} | 헤더 | 설명 | |-|-| | 수용 | 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json | [표 34. 요청 헤더] {#integrat-GET-contracts__entry__26} | 헤더 | 설명 | |-|-| | 없음 | | [표 35. 응답 헤더] ### 상태 코드 다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 [REST API HTTP 응답 코드를](https://servicenow-prod.fluidtopics.net/JHL64oGR2SkU25ZTkfHy7g "REST(REpresentational State Transfer)는 웹상의 컴퓨터 시스템 간에 표준을 제공하여 서로 보다 쉽게 통신할 수 있게 지원하는 단순한 상태 비저장 아키텍처입니다.") 참조하세요. {#integrat-GET-contracts__entry__30}{#integrat-GET-contracts__entry-200-status-code}{#integrat-GET-contracts__entry-400-status-code}{#integrat-GET-contracts__entry-403-status-code}{#integrat-GET-contracts__entry-404-status-code}{#integrat-GET-contracts__entry-500-status-code} | 상태 코드 | 설명 | |-|-| | 200 | 성공입니다. 요청이 성공적으로 처리되었습니다. | | 400 | 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다. | | 403 | 금지되었습니다. 사용자에게 지정된 기록에 대한 액세스 권한이 없습니다. | | 404 | 찾을 수 없습니다. 요청한 항목을 찾을 수 없습니다. | | 500 | 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다. | [표 36. 상태 코드] ### 응답 본문 매개변수(JSON 또는 XML) {#integrat-GET-contracts__entry__42}{#integrat-GET-contracts__error-integration-entry}{#integrat-GET-contracts__error_detail-integration-entry}{#integrat-GET-contracts__error_message-integration-entry}{#integrat-GET-contracts__has_more-integration-entry}{#integrat-GET-contracts__status-integration-entry}{#integrat-GET-contracts__sysparm_limit-integration-entry}{#integrat-GET-contracts__sysparm_offset-integration-entry} | 이름 | 설명 | |-|-| | 계약 | 지정된 설치 기반 항목 기록과 연결된 계약의 목록입니다. 데이터 형식: Object 배열 "contracts": [ { "active": "String", "approver": {Object}, "commitment": "String", "consumer": {Object}, "cost_adjustment": "String", "cost_adjustment_percentage": "String", "cost_per_unit": "String", "contract_composite": "String", "ends": "String", "expiration": {Object}, "lifetime_cost": "String", "monthly_cost": "String", "number": "String", "payment_amount": "String", "payment_schedule": {Object}, "ratecard": "String", "renewable": "String", "sales_tax": "String", "short_description": "String", "starts": "String", "state": {Object}, "sub_total_cost": "String", "sys_class_name": "String", "sys_domain_path": "String", "sys_id": "String", "tax_cost": "String", "tax_exempt": "String", "tax_rate": "String", "total_cost": "String", "vendor_contract": "String", "yearly_cost": "String" } ] | | 계약.활성 | 계약이 활성 상태인지 여부를 나타내는 플래그입니다. 가능한 값: * true: 계약이 활성 상태입니다. * false: 계약이 비활성 상태입니다. 데이터 형식: 부울 문자열 | | 계약.승인자 | 계약을 승인할 권한이 있는 사람에 대한 상세 정보입니다. 데이터 유형: 객체 "approver": { "display_value": "String", "sys_id": "String" } | | contracts.approver.display_value | 계약 기록과 연결된 승인자의 텍스트 이름입니다. 이 값을 사용하여 UI에 승인자 이름을 표시합니다. 데이터 유형: 문자열 | | contracts.approver.sys_id | 계약 기록과 연결된 승인자 기록의 Sys_id입니다. 데이터 유형: 문자열 | | 계약.소비자 | 계약 기록과 연결된 소비자에 대한 상세 정보입니다. 주: 소비자 필드는 B2B2C 플러그인이 설치된 경우에만 사용할 수 있습니다. 데이터 유형: 객체 "consumer": { "display_value": "String", "sys_id": "String" } | | contracts.consumer.display_value | 계약 기록과 연결된 소비자의 텍스트 이름입니다. 이 값을 사용하여 UI에 소비자 이름을 표시합니다. 데이터 유형: 문자열 | | contracts.consumer.sys_id | 계약 기록과 연결된 소비자 기록의 Sys_id입니다. 데이터 유형: 문자열 | | contracts.cost_adjustment | 계약에 적용된 비용 조정의 유형입니다. 가능한 값: * 고정 * 수동 * CPI(소비자 물가 지수) {#integrat-GET-contracts__ul_xwv_cny_3xb} 데이터 유형: 문자열 | | contracts.cost_adjustment_percentage | 계약 가격의 증가 또는 감소율입니다. 가격의 감소를 나타내려면 음수 백분율을 입력합니다. 비용 조정 또는 비용 조정 백분율을 지정할 수 있지만, 둘 다 지정할 수는 없습니다. 데이터 유형: 문자열 | | contracts.cost_per_unit | 제품 제공자의 단위당 비용입니다. 데이터 유형: 문자열 | | 계약.종료 | 계약이 종료되는 날짜입니다. 데이터 유형: 문자열 | | 계약.만료 | 연결된 계약의 만료 상태에 대한 상세 정보입니다. 데이터 유형: 객체 "expiration": { "display_value": "String", "sys_id": "String" } | | contracts.expiration.display_value | 연결된 계약의 만료 상태입니다. 이 값을 사용하여 UI에 만료 상태를 표시합니다. 데이터 유형: 문자열 | | contracts.expiration.sys_id | 계약 기록과 연결된 만료 기록의 Sys_id입니다. 데이터 유형: 문자열 | | contracts.lifetime_cost | 계약의 수명 비용입니다. 데이터 유형: 문자열 | | contracts.monthly_cost | 계약의 월별 비용입니다. 데이터 유형: 문자열 | | 계약.번호 | 계약 번호입니다. 데이터 유형: 문자열 | | contracts.payment_amount | 이 계약의 수령 당사자에게 직접 지불된 금액입니다. 데이터 유형: 문자열 | | contracts.payment_schedule | 계약과 연결된 지불 일정에 대한 상세 정보입니다. 데이터 유형: 객체 "payment_schedule": { "display_value": "String", "sys_id": "String" } | | contracts.payment_schedule.display_value | 연결된 계약에 대한 지불 일정입니다. 이 값을 사용하여 UI에 지불 일정을 표시합니다. 데이터 유형: 문자열 | | contracts.payment_schedule.value | 이 계약에 대한 지불 일정의 내부 값(예: 매일, 매주 또는 매월)입니다. 데이터 유형: 문자열 | | 계약.요율표 | 이 계약과 연결된 요율표가 있는지 여부를 나타내는 플래그입니다. 요율 관리 \[fm_contract_rate_card\] 테이블에 있습니다. 가능한 값: * true: 요율표 * false: 요율표가 없습니다. 데이터 형식: 부울 문자열 | | 계약.갱신 가능 | 계약이 갱신 가능한지 여부를 나타내는 플래그입니다. 가능한 값: * true: 계약을 갱신할 수 있습니다. * false: 계약을 갱신할 수 없습니다. 데이터 형식: 부울 문자열 | | contracts.sales_tax | 이 계약에서 참조하는 항목에 대해 판매세가 부과되는지 여부를 나타내는 플래그입니다. 가능한 값: * true: 판매세가 부과됩니다. * false: 판매세가 부과되지 않습니다. 데이터 형식: 부울 문자열 | | contracts.short_description | 계약에 대한 간략한 설명입니다. 데이터 유형: 문자열 | | 계약.시작 | 계약이 시작되는 날짜입니다. 데이터 유형: 문자열 | | 계약.상태 | 계약의 현재 상태에 대한 상세 정보입니다. 데이터 유형: 객체 "state": { "display_value": "String", "value": "String" } | | contracts.state.display_value | 계약의 현재 상태에 대한 텍스트 문자열입니다. 이 값을 사용하여 UI에 상태를 표시합니다. 데이터 유형: 문자열 | | contracts.state.value | 계약의 내부 값 또는 상태입니다. 데이터 유형: 문자열 | | contracts.sub_total_cost | 계약 비용의 소계입니다. 데이터 유형: 문자열 | | contracts.sys_클래스_이름 | 계약 기록이 포함된 테이블입니다. 데이터 유형: 문자열 | | contracts.sys_도메인_경로 | 이 계약을 사용할 수 있는 도메인의 경로입니다. 데이터 유형: 문자열 기본값: "/" = 전역 도메인 | | contracts.sys_id | 연결된 계약 기록의 Sys_id입니다. 데이터 유형: 문자열 | | contracts.tax_cost | 계약에 대한 총 세금입니다. 이 필드는 해당 세금 필드를 `판매`로 선택한 경우에만 표시됩니다. 데이터 유형: 문자열 | | contracts.tax_exempt | 이 계약과 관련된 항목이 면세 대상인지 여부를 나타내는 플래그입니다. 가능한 값: * true: 항목이 면세됩니다. * false: 품목이 면세 대상이 아닙니다. 데이터 형식: 부울 문자열 | | contracts.tax_rate | 계약과 관련된 과세 대상 항목에 부과되는 세율입니다. 데이터 유형: 문자열 | | contracts.total_cost | 조정 후 계약의 최종 비용이 적용되었습니다. 한 계약에 요율표가 하나 이상 있는 경우 이 필드에는 모든 요율표가 조합된 금액이 표시됩니다. 데이터 유형: 문자열 | | contracts.vendor_contract | 벤더의 계약 번호입니다. 데이터 유형: 문자열 | | contracts.yearly_cost | 계약 연도당 비용입니다. 데이터 유형: 문자열 | | 오류 | 요청을 처리하려고 할 때 발생한 오류에 대한 상세 정보입니다. 데이터 유형: 객체 "error": { "detail": "String", "message": "String" } | | 오류.상세 정보 | 관련 오류에 대한 추가 정보입니다. 데이터 유형: 문자열 | | 오류.메시지 | 요청을 실행하려고 할 때 발생한 문제를 설명하는 오류 메시지입니다. 데이터 유형: 문자열 | | has_more | 테이블에 반환할 기록이 더 있는지 여부를 나타내는 플래그입니다. 가능한 값: * true: 반환할 레코드가 더 많습니다. * false: 더 이상 반환할 기록이 없습니다. 데이터 형식: 부울 문자열 | | 상태 | 엔드포인트 호출의 상태입니다. 데이터 유형: 문자열 | | sysparm_limit | 반환된 기록 수입니다. 이 값이 원래 요청에 지정되지 않은 경우 기본값이 사용됩니다. 데이터 유형: 숫자 | | sysparm_offset | 기록이 평가 및 검색된 관련 테이블의 오프셋(시작 지점)입니다. 데이터 유형: 문자열 | [ ] ### cURL 요청 다음 코드 예제에서는 이 끝점을 호출하는 방법을 보여 줍니다. curl "https://instance.servicenow.com/api/sn_install_base/integrations/installbaseitems/167e96f053961910539dddeeff7b1298/contracts" \ --request GET \ --header "Accept:application/json" \ --user 'username':'password' 반환 결과: { "result": { "sysparm_offset": 0, "sysparm_limit": 10, "has_more": false, "contracts": [ { "cost_adjustment_percentage": "0", "total_cost": "0", "cost_adjustment": "0", "tax_rate": "7.75", "number": "CNTR0000701", "tax_cost": "0", "sub_total_cost": "0", "state": { "value": "expired", "display_value": "Expired" }, "starts": "2016-07-01", "contract_composite": "CoolMate KL300 1 year Limited Warranty\n\t\t​CNTR0000701", "tax_exempt": "false", "yearly_cost": "0", "active": "true", "payment_amount": "0", "commitment": "0", "sys_domain_path": "/", "payment_schedule": { "value": "Monthly", "display_value": "Monthly" }, "renewable": "true", "expiration": { "sys_id": "c752e78ec3103000c111113e5bba8f3a", "display_value": "Expired" }, "short_description": "CoolMate KL300 1 year Limited Warranty\n\t\t", "ratecard": "false", "sys_class_name": "ast_contract", "sys_id": "3f9db778c3302200e7c7d44d81d3ae0a", "ends": "2017-06-30", "consumer": { "sys_id": "59e788fbdb1b1200b6075200cf9619d2", "display_value": "Gilly Parker" }, "approver": { "sys_id": "f2c0b27247702000cdd1706eecde27c8", "display_value": "Software Manager" }, "monthly_cost": "0", "vendor_contract": "CNTR0000701", "lifetime_cost": "0", "sales_tax": "true", "cost_per_unit": "0" } ], "status": "SUCCESS" } } ## 설치 기반 항목 - GET /sn_install_base/integrations/installbaseitems/{id}/entitlements {#ariaid-title8} 지정된 설치 기반 항목 기록과 연결된 권리를 반환합니다.
### URL 형식 버전이 지정된 URL: /api/sn_install_base/{api_version}/integrations/installbaseitems/{id}/entitlements 기본 URL: /api/sn_install_base/integrations/installbaseitems/{id}/entitlements ### 지원되는 요청 매개변수 {#integrat-GET-entitlements__entry__2}{#integrat-GET-entitlements__version-RESTAPI}{#integrat-GET-entitlements__integrate-id-entry} | 이름 | 설명 | |-|-| | api_version | 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열 | | id | 설치 기반 항목 기록의 Sys_id입니다. 설치 기반 항목 \[sn_install_base_item\] 테이블에 있습니다. 데이터 유형: 문자열 | [표 37. 경로 매개변수] {#integrat-GET-entitlements__entry__8}{#integrat-GET-entitlements__sysparm-limit-RESTAPI}{#integrat-GET-entitlements__sysparm_offset-ph-RESTAPI} | 이름 | 설명 | |-|-| | 필드 이름-값 쌍 | 권리 기록을 필터링하는 데 사용할 필드-값 쌍입니다. 기본적으로 이는 권리 \[service_entitlement\] 테이블의 필드를 참조합니다. 에서 sys_class_name다른 테이블을 지정하는 경우 해당 테이블의 필드를 지정합니다. 하나 이상의 필드-값 쌍을 전달하여 반환 결과를 필터링할 수 있습니다. 예를 들어 활성 상태인 레코드만 반환하려면 `&active=true`를 전달합니다. 데이터 유형: 문자열 기본값: 모든 필드 | | sys_class_name | 확장된 권리 테이블(service_entitlement 아님)을 사용하는 경우 쿼리할 확장된 테이블의 이름입니다. 데이터 유형: 문자열 기본값: service_entitlement | | sysparm_limit | 반환할 최대 기록 수입니다. 이 기록 수를 초과하는 요청의 경우 sysparm_offset 매개변수를 사용하여 기록 검색을 페이지 매김합니다. 이 제한은 ACL 평가 전에 적용됩니다. 액세스할 수 있는 기록을 포함하여 반환되는 기록이 없으면 액세스할 수 있는 기록이 먼저 반환되도록 기록 순서를 다시 정렬합니다. 주: 이례적으로 큰 sysparm_limit 값은 시스템 성능에 영향을 미칠 수 있습니다. 데이터 유형: 숫자 기본값: 10000 | | sysparm_offset | 기록 검색을 시작할 시작 기록 인덱스입니다. 이 값을 사용하여 기록 검색을 페이지 매김합니다. 이 기능을 사용하면 기록 수와 관계없이 관리 가능한 작은 청크로 모든 기록을 검색할 수 있습니다. 예를 들어 이 엔드포인트를 처음 호출할 때 sysparm_offset이 "0"으로 설정됩니다. 사용 가능한 모든 기록을 간단히 살펴보려면 모든 기록이 끝날 때까지 `sysparm_offset=sysparm_offset+sysparm_limit`를 사용합니다.{#integrat-GET-entitlements__sysparm_offset-p-RESTAPI} 매개 변수에 sysparm_offset 음수를 전달하지 마세요. 데이터 유형: 숫자 기본값: 0 | [표 38. 쿼리 매개변수] {#integrat-GET-entitlements__entry__18} | 이름 | 설명 | |-|-| | 없음 | | [표 39. 요청 본문 매개변수(XML 또는 JSON)] ### 헤더 다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 [지원되는 REST API 헤더를](https://servicenow-prod.fluidtopics.net/JHL64oGR2SkU25ZTkfHy7g "REST(REpresentational State Transfer)는 웹상의 컴퓨터 시스템 간에 표준을 제공하여 서로 보다 쉽게 통신할 수 있게 지원하는 단순한 상태 비저장 아키텍처입니다.") 참조하세요. {#integrat-GET-entitlements__entry__22}{#integrat-GET-entitlements__accept-RESTAPI} | 헤더 | 설명 | |-|-| | 수용 | 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json | [표 40. 요청 헤더] {#integrat-GET-entitlements__entry__26} | 헤더 | 설명 | |-|-| | 없음 | | [표 41. 응답 헤더] ### 상태 코드 다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 [REST API HTTP 응답 코드를](https://servicenow-prod.fluidtopics.net/JHL64oGR2SkU25ZTkfHy7g "REST(REpresentational State Transfer)는 웹상의 컴퓨터 시스템 간에 표준을 제공하여 서로 보다 쉽게 통신할 수 있게 지원하는 단순한 상태 비저장 아키텍처입니다.") 참조하세요. {#integrat-GET-entitlements__entry__30}{#integrat-GET-entitlements__entry-200-status-code}{#integrat-GET-entitlements__entry-400-status-code}{#integrat-GET-entitlements__entry-403-status-code}{#integrat-GET-entitlements__entry-404-status-code}{#integrat-GET-entitlements__entry-500-status-code} | 상태 코드 | 설명 | |-|-| | 200 | 성공입니다. 요청이 성공적으로 처리되었습니다. | | 400 | 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다. | | 403 | 금지되었습니다. 사용자에게 지정된 기록에 대한 액세스 권한이 없습니다. | | 404 | 찾을 수 없습니다. 요청한 항목을 찾을 수 없습니다. | | 500 | 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다. | [표 42. 상태 코드] ### 응답 본문 매개변수(JSON 또는 XML) {#integrat-GET-entitlements__entry__42}{#integrat-GET-entitlements__error-integration-entry}{#integrat-GET-entitlements__error_detail-integration-entry}{#integrat-GET-entitlements__error_message-integration-entry}{#integrat-GET-entitlements__has_more-integration-entry}{#integrat-GET-entitlements__status-integration-entry}{#integrat-GET-entitlements__sysparm_limit-integration-entry}{#integrat-GET-entitlements__sysparm_offset-integration-entry} | 이름 | 설명 | |-|-| | 권리 | 지정된 설치 기반 항목 기록과 연결된 권리의 목록입니다. 데이터 유형: 객체 "entitlements": { "account": {Object}, "active": "String", "business_hour": {Object}, "contract": {Object}, "end_date": "String", "entitlement_name": "String", "install_base_item": {Object}, "per_unit": "String", "start_date": "String", "sys_id": "String", "total_units": "String", "remaining_units": "String", "unit": {Object} } | | entitlements.account | 권리 기록과 연결된 계정에 대한 상세 정보입니다. 데이터 유형: 객체 "account": { "display_value": "String", "sys_id": "String" } | | entitlements.account.display_value | 권리 기록과 연결된 계정의 텍스트 이름입니다. 이 값을 사용하여 UI에 계정 이름을 표시합니다. 데이터 유형: 문자열 | | entitlements.account.sys_id | 권리 기록과 연결된 계정 기록의 Sys_id입니다. 데이터 유형: 문자열 | | entitlements.active | 권리가 활성 상태인지 여부를 나타내는 플래그입니다. 가능한 값: * 0: 권리가 활성 상태가 아닙니다. * 1: 권리가 활성 상태입니다. 데이터 유형: 문자열 기본값: 1 | | entitlements.business_hour | 권리 기록의 업무 시간에 대한 상세 정보입니다. 데이터 유형: 객체 "business_hour": { "display_value": "String", "sys_id": "String" } | | entitlements.business_hour.display_value | 권리 기록과 연결된 업무 시간 기록의 텍스트 이름입니다. 이 값을 사용하여 UI에 업무 시간을 표시합니다. 데이터 유형: 문자열 | | entitlements.business_hour.sys_id | 권리 기록과 연결된 업무 시간 기록의 Sys_id입니다. 데이터 유형: 문자열 | | entitlements.contract | 권리 기록과 연결된 계약에 대한 상세 정보입니다. 데이터 유형: 객체 "contract": { "display_value": "String", "sys_id": "String" } | | entitlements.contract.display_value | 권리 기록과 연결된 계약의 텍스트 이름입니다. 이 값을 사용하여 UI에 계약 이름을 표시합니다. 데이터 유형: 문자열 | | entitlements.contract.sys_id | 권리 기록과 연결된 계약 기록의 Sys_id입니다. 데이터 유형: 문자열 | | entitlements.end_date | 권리의 종료 날짜입니다. 데이터 유형: 문자열 | | entitlements.entitlement_name | 권리의 이름입니다. 데이터 유형: 문자열 | | entitlements.install_base_item | 권리 기록과 연결된 설치 기반 항목에 대한 상세 정보입니다. 데이터 유형: 객체 "install_base_item": { "display_value": "String", "sys_id": "String" } | | entitlements.install_base_item.display_value | 권리 기록과 연결된 설치 기반 항목의 텍스트 이름입니다. 이 값을 사용하여 UI에 설치 기반 항목 이름을 표시합니다. 데이터 유형: 문자열 | | entitlements.install_base_item.sys_id | 권리 기록과 연결된 설치 기반 항목 기록의 Sys_id입니다. 데이터 유형: 문자열 | | entitlements.per_unit | 단위의 제품 수입니다. 예를 들어 케이스인 경우 unit 케이스당 항목이 12개이면 이 값은 12가 됩니다. 데이터 유형: 문자열 | | entitlements.start_date | 권리의 시작 날짜입니다. 데이터 유형: 문자열 | | entitlements.sys_id | 연결된 권리 기록의 Sys_id입니다. 데이터 유형: 문자열 | | entitlements.total_units | 원래 사용할 수 있었던 단위 수입니다. 데이터 유형: 문자열 | | entitlements.remaining_units | 남아 있는 단위 수입니다. 데이터 유형: 문자열 | | entitlements.unit | 권리 기록과 연결된 항목의 단위에 대한 상세 정보입니다. 데이터 유형: 객체 "unit": { "display_value": "String", "value": "String" } | | entitlements.unit.display_value | 권리 기록과 연결된 항목 단위의 텍스트 이름입니다. 이 값을 사용하여 UI에 장치 이름을 표시합니다. 데이터 유형: 문자열 | | entitlements.unit.value | 권리 기록과 연결된 항목 단위의 내부 이름입니다. 데이터 유형: 문자열 | | 오류 | 요청을 처리하려고 할 때 발생한 오류에 대한 상세 정보입니다. 데이터 유형: 객체 "error": { "detail": "String", "message": "String" } | | 오류.상세 정보 | 관련 오류에 대한 추가 정보입니다. 데이터 유형: 문자열 | | 오류.메시지 | 요청을 실행하려고 할 때 발생한 문제를 설명하는 오류 메시지입니다. 데이터 유형: 문자열 | | has_more | 테이블에 반환할 기록이 더 있는지 여부를 나타내는 플래그입니다. 가능한 값: * true: 반환할 레코드가 더 많습니다. * false: 더 이상 반환할 기록이 없습니다. 데이터 형식: 부울 문자열 | | 상태 | 엔드포인트 호출의 상태입니다. 데이터 유형: 문자열 | | sysparm_limit | 반환된 기록 수입니다. 이 값이 원래 요청에 지정되지 않은 경우 기본값이 사용됩니다. 데이터 유형: 숫자 | | sysparm_offset | 기록이 평가 및 검색된 관련 테이블의 오프셋(시작 지점)입니다. 데이터 유형: 문자열 | [ ] ### cURL 요청 다음 코드 예제에서는 이 끝점을 호출하는 방법을 보여 줍니다. curl "https://instance.servicenow.com/api/sn_install_base/integrations/installbaseitems/42746a3b876121100b6afc86dabb3597/entitlements" \ --request GET \ --header "Accept:application/json" \ --user 'username':'password' 반환 결과: { "result": { "sysparm_offset": 0, "sysparm_limit": 10, "has_more": false, "entitlements": [ { "end_date": "2023-04-28", "remaining_units": "4978", "business_hour": { "sys_id": "08fcd0830a0a0b2600079f56b1adb9ae", "display_value": "8-5 weekdays" }, "entitlement_name": "Entitlement", "sys_id": "7206095d87f121105d0055373cbb3504", "total_units": "5000", "start_date": "2023-03-27", "contract": { "sys_id": "495e16b96f0731003b3c498f5d3ee4af", "display_value": "CNTR0000603" }, "active": "1", "install_base_item": { "sys_id": "42746a3b876121100b6afc86dabb3597", "display_value": "KX Series - KX5000" }, "unit": { "value": "cases", "display_value": "Cases" }, "per_unit": "0", "account": { "sys_id": "86837a386f0331003b3c498f5d3ee4ca", "display_value": "Boxeo" } } ], "status": "SUCCESS" } } ## 설치 기반 항목 - GET /sn_install_base/integrations/installbaseitems/{id}/maintenanceplans {#ariaid-title9} 지정된 설치 기반 항목 기록과 연결된 유지관리 계획을 반환합니다.
### URL 형식 버전이 지정된 URL: /api/sn_install_base/{api_version}/integrations/installbaseitems/{id}/maintenanceplans 기본 URL: /api/sn_install_base/integrations/installbaseitems/{id}/maintenanceplans ### 지원되는 요청 매개변수 {#integrat-GET-maintenanceplans__entry__2}{#integrat-GET-maintenanceplans__version-RESTAPI}{#integrat-GET-maintenanceplans__integrate-id-entry} | 이름 | 설명 | |-|-| | api_version | 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열 | | id | 설치 기반 항목 기록의 Sys_id입니다. 설치 기반 항목 \[sn_install_base_item\] 테이블에 있습니다. 데이터 유형: 문자열 | [표 43. 경로 매개변수] {#integrat-GET-maintenanceplans__entry__8}{#integrat-GET-maintenanceplans__sysparm-limit-RESTAPI}{#integrat-GET-maintenanceplans__sysparm_offset-ph-RESTAPI} | 이름 | 설명 | |-|-| | 필드 이름-값 쌍 | 유지관리 계획 기록을 필터링하는 데 사용할 필드-값 쌍입니다. 기본적으로 이 필드는 유지관리 계획 \[sm_maint_plan\] 테이블의 필드를 참조합니다. 에서 sys_class_name다른 테이블을 지정하는 경우 해당 테이블의 필드를 지정합니다. 하나 이상의 필드-값 쌍을 전달하여 반환 결과를 필터링할 수 있습니다. 예를 들어 활성 상태인 레코드만 반환하려면 `&active=true`를 전달합니다. 데이터 유형: 문자열 기본값: 모든 필드 | | sys_class_name | maintenanceplans 아님 연장된 유지관리 계획 테이블을 사용하는 경우 쿼리할 확장된 테이블의 이름입니다. 데이터 유형: 문자열 기본값: maintenanceplans | | sysparm_limit | 반환할 최대 기록 수입니다. 이 기록 수를 초과하는 요청의 경우 sysparm_offset 매개변수를 사용하여 기록 검색을 페이지 매김합니다. 이 제한은 ACL 평가 전에 적용됩니다. 액세스할 수 있는 기록을 포함하여 반환되는 기록이 없으면 액세스할 수 있는 기록이 먼저 반환되도록 기록 순서를 다시 정렬합니다. 주: 이례적으로 큰 sysparm_limit 값은 시스템 성능에 영향을 미칠 수 있습니다. 데이터 유형: 숫자 기본값: 10000 | | sysparm_offset | 기록 검색을 시작할 시작 기록 인덱스입니다. 이 값을 사용하여 기록 검색을 페이지 매김합니다. 이 기능을 사용하면 기록 수와 관계없이 관리 가능한 작은 청크로 모든 기록을 검색할 수 있습니다. 예를 들어 이 엔드포인트를 처음 호출할 때 sysparm_offset이 "0"으로 설정됩니다. 사용 가능한 모든 기록을 간단히 살펴보려면 모든 기록이 끝날 때까지 `sysparm_offset=sysparm_offset+sysparm_limit`를 사용합니다.{#integrat-GET-maintenanceplans__sysparm_offset-p-RESTAPI} 매개 변수에 sysparm_offset 음수를 전달하지 마세요. 데이터 유형: 숫자 기본값: 0 | [표 44. 쿼리 매개변수] {#integrat-GET-maintenanceplans__entry__18} | 이름 | 설명 | |-|-| | 없음 | | [표 45. 요청 본문 매개변수(XML 또는 JSON)] ### 헤더 다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 [지원되는 REST API 헤더를](https://servicenow-prod.fluidtopics.net/JHL64oGR2SkU25ZTkfHy7g "REST(REpresentational State Transfer)는 웹상의 컴퓨터 시스템 간에 표준을 제공하여 서로 보다 쉽게 통신할 수 있게 지원하는 단순한 상태 비저장 아키텍처입니다.") 참조하세요. {#integrat-GET-maintenanceplans__entry__22}{#integrat-GET-maintenanceplans__accept-RESTAPI} | 헤더 | 설명 | |-|-| | 수용 | 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json | [표 46. 요청 헤더] {#integrat-GET-maintenanceplans__entry__26} | 헤더 | 설명 | |-|-| | 없음 | | [표 47. 응답 헤더] ### 상태 코드 다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 [REST API HTTP 응답 코드를](https://servicenow-prod.fluidtopics.net/JHL64oGR2SkU25ZTkfHy7g "REST(REpresentational State Transfer)는 웹상의 컴퓨터 시스템 간에 표준을 제공하여 서로 보다 쉽게 통신할 수 있게 지원하는 단순한 상태 비저장 아키텍처입니다.") 참조하세요. {#integrat-GET-maintenanceplans__entry__30}{#integrat-GET-maintenanceplans__entry-200-status-code}{#integrat-GET-maintenanceplans__entry-400-status-code}{#integrat-GET-maintenanceplans__entry-403-status-code}{#integrat-GET-maintenanceplans__entry-404-status-code}{#integrat-GET-maintenanceplans__entry-500-status-code} | 상태 코드 | 설명 | |-|-| | 200 | 성공입니다. 요청이 성공적으로 처리되었습니다. | | 400 | 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다. | | 403 | 금지되었습니다. 사용자에게 지정된 기록에 대한 액세스 권한이 없습니다. | | 404 | 찾을 수 없습니다. 요청한 항목을 찾을 수 없습니다. | | 500 | 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다. | [표 48. 상태 코드] ### 응답 본문 매개변수(JSON 또는 XML) {#integrat-GET-maintenanceplans__entry__42}{#integrat-GET-maintenanceplans__error-integration-entry}{#integrat-GET-maintenanceplans__error_detail-integration-entry}{#integrat-GET-maintenanceplans__error_message-integration-entry}{#integrat-GET-maintenanceplans__has_more-integration-entry}{#integrat-GET-maintenanceplans__status-integration-entry}{#integrat-GET-maintenanceplans__sysparm_limit-integration-entry}{#integrat-GET-maintenanceplans__sysparm_offset-integration-entry} | 이름 | 설명 | |-|-| | 오류 | 요청을 처리하려고 할 때 발생한 오류에 대한 상세 정보입니다. 데이터 유형: 객체 "error": { "detail": "String", "message": "String" } | | 오류.상세 정보 | 관련 오류에 대한 추가 정보입니다. 데이터 유형: 문자열 | | 오류.메시지 | 요청을 실행하려고 할 때 발생한 문제를 설명하는 오류 메시지입니다. 데이터 유형: 문자열 | | has_more | 테이블에 반환할 기록이 더 있는지 여부를 나타내는 플래그입니다. 가능한 값: * true: 반환할 레코드가 더 많습니다. * false: 더 이상 반환할 기록이 없습니다. 데이터 형식: 부울 문자열 | | 유지관리 계획 | 지정된 설치 기반 항목 기록과 연결된 유지관리 계획의 목록입니다. 데이터 형식: Object 배열 "maintenanceplans": [ { "active": "String", "apply_to_new": "String", "allow_future_wo": "String", "maintenance_override_policy": {Object}, "model": "String", "name": "String", "number": "String", "propagation_flag": "String", "sys_class_name": "String", "sys_id": "String", "table": "String", "type": {Object} } ] | | MaintenancePlans를 참조하십시오.활동적인 | 유지관리 계획이 활성 상태인지 여부를 나타내는 플래그입니다. 가능한 값: * true: 유지관리 계획이 활성 상태입니다. * false: 유지관리 계획이 비활성 상태입니다. 데이터 유형: 문자열 | | MaintenancePlans를 참조하십시오.apply_to_new | 이 유지관리 계획에 대해 정의된 일정이 계획이 마지막으로 실행된 이후 지정된 테이블에 추가된 모든 기록에 적용되는지 여부와 필터 조건에 입력된 조건을 충족하는지 여부를 나타내는 플래그입니다. 가능한 값: * true: 모든 새 기록에 적용됩니다. * false: 모든 새 레코드에 적용되지 않습니다. 데이터 유형: 문자열 | | MaintenancePlans를 참조하십시오.allow_future_wo | 작업 주문을 유지관리 계획과 연결할 수 있는지 여부를 나타내는 플래그입니다. 가능한 값: * true: 새 작업 주문을 연결할 수 있습니다. * false: 새 작업 주문을 연관시킬 수 없습니다. 데이터 유형: 문자열 | | MaintenancePlans를 참조하십시오.maintenance_override_policy | 유지관리 계획의 유지관리 재정의 정책에 대한 상세 정보입니다. 데이터 유형: 객체 "maintenance_override_policy": { "display_value": "String", "value": "String" } | | MaintenancePlans를 참조하십시오.maintenance_override_policy.display_value | 재정의 정책을 설명하는 텍스트 문자열입니다. 이 값을 사용하여 UI에 재정의 정책을 표시합니다. 데이터 유형: 문자열 | | MaintenancePlans를 참조하십시오.maintenance_override_policy.값 | 무효화 정책의 내부 값입니다. 데이터 유형: 문자열 | | MaintenancePlans를 참조하십시오.모델 | 유지관리 계획과 연결된 모델 기록의 Sys_id입니다. 데이터 유형: 문자열 | | MaintenancePlans를 참조하십시오.수 | 유지관리 계획 번호입니다. 데이터 유형: 문자열 | | MaintenancePlans를 참조하십시오.propagation_flag | 유지관리 계획을 전파할 수 있는지 여부를 나타내는 플래그입니다. 가능한 값: * true: 유지관리 계획을 전파할 수 있습니다. * false: 유지관리 계획을 전파할 수 없습니다. 데이터 유형: 문자열 | | MaintenancePlans를 참조하십시오.sys_class_name | 유지관리 계획 기록이 포함된 테이블입니다. 데이터 유형: 문자열 | | MaintenancePlans를 참조하십시오.sys_id | 연결된 유지관리 계획의 Sys_id입니다. 데이터 유형: 문자열 | | MaintenancePlans를 참조하십시오.테이블 | 연결된 설치 기반 시간 기록이 포함된 테이블입니다. 데이터 유형: 문자열 | | MaintenancePlans를 참조하십시오.형 | 유지관리 계획의 유형에 대한 상세 정보입니다. 데이터 유형: 객체 "type": { "display_value": "String", "value": "String" } | | MaintenancePlans를 참조하십시오.형.display_value | 유지관리 계획 유형을 설명하는 텍스트 문자열입니다. 이 값을 사용하여 UI에 유형을 표시합니다. 데이터 유형: 문자열 | | MaintenancePlans를 참조하십시오.형.값 | 유지관리 계획 유형의 내부 값입니다. 데이터 유형: 문자열 | | 상태 | 엔드포인트 호출의 상태입니다. 데이터 유형: 문자열 | | sysparm_limit | 반환된 기록 수입니다. 이 값이 원래 요청에 지정되지 않은 경우 기본값이 사용됩니다. 데이터 유형: 숫자 | | sysparm_offset | 기록이 평가 및 검색된 관련 테이블의 오프셋(시작 지점)입니다. 데이터 유형: 문자열 | [ ] ### cURL 요청 다음 코드 예제에서는 이 끝점을 호출하는 방법을 보여 줍니다. curl "https://instance.servicenow.com/api/sn_install_base/integrations/installbaseitems/167e96f053961910539dddeeff7b1298/maintenanceplans" \ --request GET \ --header "Accept:application/json" \ --user 'username':'password' 반환 결과: { "result": { "sysparm_offset": 0, "sysparm_limit": 1, "has_more": true, "maintenanceplans": [ { "propagation_flag": "false", "active": "true", "type": { "value": "install_base", "display_value": "Install base" }, "maintenance_override_policy": { "value": "do_nothing", "display_value": "Leave alone" }, "sys_class_name": "wm_planned_work_plan", "allow_future_wo": "true", "sys_id": "0b809d70877561105d0055373cbb357f", "number": "WP0001026", "name": "Plan 10", "model": "8583ce8237732000158bbfc8bcbe5dd9", "apply_to_new": "true", "table": "sn_install_base_item" } ], "status": "SUCCESS" } } ## 설치 기반 항목 - GET /sn_install_base/integrations/installbaseitems/{id}/relatedparties {#ariaid-title10} 지정된 설치 기반 항목 기록과 연결된 관련 당사자를 반환합니다.
### URL 형식 버전이 지정된 URL: /api/sn_install_base/{api_version}/integrations/installbaseitems/{id}/relatedparties 기본 URL: /api/sn_install_base/integrations/installbaseitems/{id}/relatedparties ### 지원되는 요청 매개변수 {#integrat-GET-relatedparties__entry__2}{#integrat-GET-relatedparties__version-RESTAPI}{#integrat-GET-relatedparties__integrate-id-entry} | 이름 | 설명 | |-|-| | api_version | 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열 | | id | 설치 기반 항목 기록의 Sys_id입니다. 설치 기반 항목 \[sn_install_base_item\] 테이블에 있습니다. 데이터 유형: 문자열 | [표 49. 경로 매개변수] {#integrat-GET-relatedparties__entry__8}{#integrat-GET-relatedparties__sysparm-limit-RESTAPI}{#integrat-GET-relatedparties__sysparm_offset-ph-RESTAPI} | 이름 | 설명 | |-|-| | 필드 이름-값 쌍 | 관련 당사자 기록을 필터링하는 데 사용할 필드-값 쌍입니다. 기본적으로 이는 관련 당사자 \[sn_install_base_related_party\] 테이블의 필드를 참조합니다. 에서 sys_class_name다른 테이블을 지정하는 경우 해당 테이블의 필드를 지정합니다. 하나 이상의 필드-값 쌍을 전달하여 반환 결과를 필터링할 수 있습니다. 예를 들어 특정 계정과 책임 당사자를 필터링하려면 `&account=86837a386f0331003b3c498f5d3ee4ca&responsibility=c009bbedb3730010700b4d43c6a8dcef` 두 기록의 sys_ids 전달합니다. 데이터 유형: 문자열 기본값: 모든 필드 | | sys_class_name | 확장된 특수관계자 테이블(sn_install_base_related_party 아님)을 사용하는 경우 쿼리할 확장된 테이블의 이름입니다. 데이터 유형: 문자열 기본값: sn_install_base_related_party | | sysparm_limit | 반환할 최대 기록 수입니다. 이 기록 수를 초과하는 요청의 경우 sysparm_offset 매개변수를 사용하여 기록 검색을 페이지 매김합니다. 이 제한은 ACL 평가 전에 적용됩니다. 액세스할 수 있는 기록을 포함하여 반환되는 기록이 없으면 액세스할 수 있는 기록이 먼저 반환되도록 기록 순서를 다시 정렬합니다. 주: 이례적으로 큰 sysparm_limit 값은 시스템 성능에 영향을 미칠 수 있습니다. 데이터 유형: 숫자 기본값: 10000 | | sysparm_offset | 기록 검색을 시작할 시작 기록 인덱스입니다. 이 값을 사용하여 기록 검색을 페이지 매김합니다. 이 기능을 사용하면 기록 수와 관계없이 관리 가능한 작은 청크로 모든 기록을 검색할 수 있습니다. 예를 들어 이 엔드포인트를 처음 호출할 때 sysparm_offset이 "0"으로 설정됩니다. 사용 가능한 모든 기록을 간단히 살펴보려면 모든 기록이 끝날 때까지 `sysparm_offset=sysparm_offset+sysparm_limit`를 사용합니다.{#integrat-GET-relatedparties__sysparm_offset-p-RESTAPI} 매개 변수에 sysparm_offset 음수를 전달하지 마세요. 데이터 유형: 숫자 기본값: 0 | [표 50. 쿼리 매개변수] {#integrat-GET-relatedparties__entry__18} | 이름 | 설명 | |-|-| | 없음 | | [표 51. 요청 본문 매개변수(XML 또는 JSON)] ### 헤더 다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 [지원되는 REST API 헤더를](https://servicenow-prod.fluidtopics.net/JHL64oGR2SkU25ZTkfHy7g "REST(REpresentational State Transfer)는 웹상의 컴퓨터 시스템 간에 표준을 제공하여 서로 보다 쉽게 통신할 수 있게 지원하는 단순한 상태 비저장 아키텍처입니다.") 참조하세요. {#integrat-GET-relatedparties__entry__22}{#integrat-GET-relatedparties__accept-RESTAPI} | 헤더 | 설명 | |-|-| | 수용 | 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json | [표 52. 요청 헤더] {#integrat-GET-relatedparties__entry__26} | 헤더 | 설명 | |-|-| | 없음 | | [표 53. 응답 헤더] ### 상태 코드 다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 [REST API HTTP 응답 코드를](https://servicenow-prod.fluidtopics.net/JHL64oGR2SkU25ZTkfHy7g "REST(REpresentational State Transfer)는 웹상의 컴퓨터 시스템 간에 표준을 제공하여 서로 보다 쉽게 통신할 수 있게 지원하는 단순한 상태 비저장 아키텍처입니다.") 참조하세요. {#integrat-GET-relatedparties__entry__30}{#integrat-GET-relatedparties__entry-200-status-code}{#integrat-GET-relatedparties__entry-400-status-code}{#integrat-GET-relatedparties__entry-403-status-code}{#integrat-GET-relatedparties__entry-404-status-code}{#integrat-GET-relatedparties__entry-500-status-code} | 상태 코드 | 설명 | |-|-| | 200 | 성공입니다. 요청이 성공적으로 처리되었습니다. | | 400 | 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다. | | 403 | 금지되었습니다. 사용자에게 지정된 기록에 대한 액세스 권한이 없습니다. | | 404 | 찾을 수 없습니다. 요청한 항목을 찾을 수 없습니다. | | 500 | 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다. | [표 54. 상태 코드] ### 응답 본문 매개변수(JSON 또는 XML) {#integrat-GET-relatedparties__id_gls_y2f_zwb__entry__2}{#integrat-GET-relatedparties__related_parties-integration-entry}{#integrat-GET-relatedparties__account-rp-integration-entry}{#integrat-GET-relatedparties__account_display_value-rp-integration-entry}{#integrat-GET-relatedparties__account_sys_id-rp-integration-entry}{#integrat-GET-relatedparties__consumer-rp-integration-entry}{#integrat-GET-relatedparties__consumer_display_value-rp-integration-entry}{#integrat-GET-relatedparties__consumer_sys_id-rp-integration-entry}{#integrat-GET-relatedparties__contact-rp-integration-entry}{#integrat-GET-relatedparties__contact_display_value-rp-integration-entry}{#integrat-GET-relatedparties__contact_sys_id-rp-integration-entry}{#integrat-GET-relatedparties__install_base_item-rp-integration-entry}{#integrat-GET-relatedparties__install_base_item_display_value-rp-integration-entry}{#integrat-GET-relatedparties__install_base_item_sys_id-rp-integration-entry}{#integrat-GET-relatedparties__responsibility-rp-integration-entry}{#integrat-GET-relatedparties__responsibility_display_value-rp-integration-entry}{#integrat-GET-relatedparties__responsibility_sys_id-rp-integration-entry}{#integrat-GET-relatedparties__sys_class_name-rp-integration-entry}{#integrat-GET-relatedparties__sys_id-rp-integration-entry}{#integrat-GET-relatedparties__type-rp-integration-entry}{#integrat-GET-relatedparties__type_display_value-rp-integration-entry}{#integrat-GET-relatedparties__type_sys_id-rp-integration-entry}{#integrat-GET-relatedparties__user-rp-integration-entry}{#integrat-GET-relatedparties__user_display_value-rp-integration-entry}{#integrat-GET-relatedparties__user_sys_id-rp-integration-entry}{#integrat-GET-relatedparties__status-integration-entry}{#integrat-GET-relatedparties__sysparm_limit-integration-entry}{#integrat-GET-relatedparties__sysparm_offset-integration-entry} | 이름 | 설명 | |-|-| | 오류 | 요청을 처리하려고 할 때 발생한 오류에 대한 상세 정보입니다. 데이터 유형: 객체 "error": { "detail": "String", "message": "String" } | | 오류.상세 정보 | 관련 오류에 대한 추가 정보입니다. 데이터 유형: 문자열 | | 오류.메시지 | 요청을 실행하려고 할 때 발생한 문제를 설명하는 오류 메시지입니다. 데이터 유형: 문자열 | | has_more | 테이블에 반환할 기록이 더 있는지 여부를 나타내는 플래그입니다. 가능한 값: * true: 반환할 레코드가 더 많습니다. * false: 더 이상 반환할 기록이 없습니다. 데이터 형식: 부울 문자열 | | 관련 당사자 | 지정된 설치 기반 항목 기록과 연결된 관련 당사자의 목록입니다. 데이터 형식: 객체 배열 "relatedparties": [ { "account": {Object}, "consumer": {Object}, "contact": {Object}, "install_base_item": {Object}, "responsibility": {Object}, "service_organization": {Object}, "sys_class_name": "String", "sys_id": "String", "type": {Object}, "user": {Object} } ] | | 관련 당사자.계정 | 관련 당사자 기록과 연결된 계정에 대한 상세 정보입니다. 데이터 유형: 객체 account": { "display_value": "String", "sys_id": "String" } | | relatedparties.account.display_value | 관련 당사자 기록과 연결된 계정의 텍스트 이름입니다. 이 값을 사용하여 UI에 계정 이름을 표시합니다. 데이터 유형: 문자열 | | relatedparties.account.sys_id | 관련 당사자 기록과 연결된 계정 기록의 Sys_id입니다. 데이터 유형: 문자열 | | 관련 당사자.소비자 | 관련 당사자 기록과 연결된 소비자에 대한 상세 정보입니다. 데이터 유형: 객체 "consumer": { "display_value": "String", "sys_id": "String" } | | relatedparties.consumer.display_value | 관련 당사자 기록과 연결된 소비자의 텍스트 이름입니다. 이 값을 사용하여 UI에 소비자 이름을 표시합니다. 데이터 유형: 문자열 | | relatedparties.consumer.sys_id | 관련 당사자 기록과 연결된 소비자 기록의 Sys_id입니다. 데이터 유형: 문자열 | | 관련 당사자.연락처 | 관련 당사자 기록을 담당하는 계정 연락처에 대한 상세 정보입니다. 데이터 유형: 객체 "contact": { "display_value": "String", "sys_id": "String" } | | relatedparties.contact.display_value | 관련 당사자 기록과 연결된 연락처의 텍스트 이름입니다. 이 값을 사용하여 UI에 연락처 이름을 표시합니다. 데이터 유형: 문자열 | | relatedparties.contact.sys_id | 관련 당사자 기록과 연결된 연락처 기록의 Sys_id입니다. 연락처 \[customer_contact\] 테이블에 있습니다. 데이터 유형: 문자열 | | relatedparties.install_base_item | 관련 당사자 기록과 연결된 설치 기반 항목에 대한 상세 정보입니다. 데이터 유형: 객체 "install_base_item": { "display_value": "String", "sys_id": "String" } | | relatedparties.install_base_item.display_value | 관련 당사자 기록과 연결된 설치 기반 항목의 텍스트 이름입니다. 이 값을 사용하여 UI에 설치 기반 항목 이름을 표시합니다. 데이터 유형: 문자열 | | relatedparties.install_base_item.sys_id | 관련 당사자 기록과 연결된 설치 기반 항목 기록의 Sys_id입니다. 데이터 유형: 문자열 | | 관련 당사자.책임 | 설치 기반 정보의 접근 수준에 대한 세부 정보입니다. 데이터 유형: 객체 "responsibility": { "display_value": "String", "sys_id": "String" } | | relatedparties.responsibility.display_value | 설치 기반 정보에 대한 접근 수준에 대한 텍스트 표시 값입니다. 데이터 유형: 문자열 | | relatedparties.responsibility.sys_id | 연결된 책임 기록의 Sys_id입니다. 이 기록은 설치 기반 정보에 대한 액세스 수준을 정의합니다. 책임 정의 \[sn_customerservice_responsibility_def\] 테이블에 있습니다. 이 매개변수는 필드도 related_party 지정된 경우에만 유효합니다. 지정한 경우 및 responsibility 매개변수 모두 related_party 와 일치하는 설치 기반 항목만 반환합니다. 자세한 내용은 다음을 참조하십시오. [Configure related parties for items received](https://www.servicenow.com/docs/access?context=psds-add-related-parties-to-record&version=xanadu&pubname=xanadu-government-industry&ft:locale=en-US) 데이터 유형: 문자열 | | relatedparties.service_organization | 관련 당사자 기록과 연결된 서비스 조직에 대한 상세 정보입니다. 데이터 유형: 객체 "service_organization": { "display_value": "String", "sys_id": "String" } | | relatedparties.service_organization.display_value | 관련 당사자 기록과 연결된 서비스 조직의 텍스트 이름입니다. 이 값을 사용하여 UI에 서비스 조직 이름을 표시합니다. 데이터 유형: 문자열 | | relatedparties.service_organization.sys_id | 관련 당사자 기록과 연결된 서비스 조직 기록의 Sys_id입니다. 서비스 조직 \[sn_customer_service_organization\] 테이블에 있습니다. 데이터 유형: 문자열 | | relatedparties.sys_클래스_이름 | 관련 당사자 기록이 포함된 테이블입니다. 데이터 유형: 문자열 기본값: sn_install_base_related_party | | relatedparties.sys_id | 연결된 관련 당사자 기록의 Sys_id입니다. 데이터 유형: 문자열 | | 관련 당사자.유형 | 관련 당사자 기록과 연결된 연락처 유형에 대한 상세 정보입니다. 데이터 유형: 객체 "type": { "display_value": "String", "sys_id": "String" } | | relatedparties.type.display_value | 관련 당사자 기록과 연결된 연락처 유형의 텍스트 이름입니다. 이 값을 사용하여 UI에 연락처 유형을 표시합니다. 자세한 내용은 [Add related party configurations to cases, sold products, install bases, or service organizations](https://www.servicenow.com/docs/access?context=adding-related-party-config-to-case&version=xanadu&pubname=xanadu-customer-service-management&ft:locale=en-US) 문서를 참조하십시오. 가능한 유형: * 인증된 계정 * 인증된 소비자 * 인증된 접촉 창구 * 인증된 기고자 * 인증된 구성원 * 공인 서비스 조직 * 목록에 있는 계정 * 소비자 목록 * 접촉 창구 목록 * 목록에 있는 기고자 * 목록에 있는 구성원 * 목록에 있는 서비스 조직 데이터 유형: 문자열 | | relatedparties.type.sys_id | 관련 당사자 기록과 연결된 유형 기록의 Sys_id입니다. 데이터 유형: 문자열 | | 관련 당사자.사용자 | 관련 당사자 기록과 연결된 사용자에 대한 상세 정보입니다. 데이터 유형: 객체 "user": { "display_value": "String", "sys_id": "String" } | | relatedparties.user.display_value | 관련 당사자 기록과 연결된 사용자의 텍스트 이름입니다. 이 값을 사용하여 UI에 사용자 이름을 표시합니다. 데이터 유형: 문자열 | | relatedparties.user.sys_id | 관련 당사자 기록과 연결된 사용자 기록의 Sys_id입니다. 사용자 \[sys_user\] 테이블에 있습니다. 데이터 유형: 문자열 | | 상태 | 엔드포인트 호출의 상태입니다. 데이터 유형: 문자열 | | sysparm_limit | 반환된 기록 수입니다. 이 값이 원래 요청에 지정되지 않은 경우 기본값이 사용됩니다. 데이터 유형: 숫자 | | sysparm_offset | 기록이 평가 및 검색된 관련 테이블의 오프셋(시작 지점)입니다. 데이터 유형: 문자열 | [ ] {#integrat-GET-relatedparties__id_gls_y2f_zwb} ### cURL 요청 다음 코드 예제에서는 이 끝점을 호출하는 방법을 보여 줍니다. curl "https://instance.servicenow.com/api/sn_install_base/integrations/installbaseitems/42746a3b876121100b6afc86dabb3597/relatedparties" \ --request GET \ --header "Accept:application/json" \ --user 'username':'password' 반환 결과: "result": { "sysparm_offset": 0, "sysparm_limit": 10, "has_more": false, "relatedparties": [ { "type": { "sys_id": "68ec8b2965e99110f87764df53db779f", "display_value": "Authorized Contact" }, "install_base_item": { "sys_id": "42746a3b876121100b6afc86dabb3597", "display_value": "KX Series - KX5000" }, "sys_class_name": "sn_install_base_related_party", "sys_id": "8547774087f561100b6afc86dabb351a", "responsibility": { "sys_id": "c009bbedb3730010700b4d43c6a8dcef", "display_value": "Authorized Representative" }, "contact": { "sys_id": "dc0185d94f341200025ba3618110c77c", "display_value": "Cindy Contact" }, "account": { "sys_id": "86837a386f0331003b3c498f5d3ee4ca", "display_value": "Boxeo" } } ], "status": "SUCCESS" } } ## 설치 기반 항목 - GET /sn_install_base/integrations/installbaseitems/{id}/soldproducts {#ariaid-title11} 지정된 설치 기반 항목 기록과 연결된 판매된 제품 기록을 반환합니다.
### URL 형식 버전이 지정된 URL: /api/sn_install_base/{api_version}/integrations/installbaseitems/{id}/soldproducts 기본 URL: /api/sn_install_base/integrations/installbaseitems/{id}/soldproducts ### 지원되는 요청 매개변수 {#integrat-GET-soldproducts__entry__2}{#integrat-GET-soldproducts__version-RESTAPI}{#integrat-GET-soldproducts__integrate-id-entry} | 이름 | 설명 | |-|-| | api_version | 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열 | | id | 설치 기반 항목 기록의 Sys_id입니다. 설치 기반 항목 \[sn_install_base_item\] 테이블에 있습니다. 데이터 유형: 문자열 | [표 55. 경로 매개변수] {#integrat-GET-soldproducts__entry__8}{#integrat-GET-soldproducts__sysparm-limit-RESTAPI}{#integrat-GET-soldproducts__sysparm_offset-ph-RESTAPI} | 이름 | 설명 | |-|-| | 필드 이름-값 쌍 | 관련 당사자 기록을 필터링하는 데 사용할 필드-값 쌍입니다. 기본적으로 이는 판매된 제품 \[sn_install_base_sold_product\] 테이블의 필드를 참조합니다. 에서 sys_class_name다른 테이블을 지정하는 경우 해당 테이블의 필드를 지정합니다. 하나 이상의 필드-값 쌍을 전달하여 반환 결과를 필터링할 수 있습니다. 예를 들어 특정 계정에 판매된 제품을 필터링하려면 전달된 값이 계정의 sys_id인 `&account=86837a386f0331003b3c498f5d3ee4ca`와 유사한 값을 전달합니다. 데이터 유형: 문자열 기본값: 모든 필드 | | sys_class_name | 확장된 판매 제품 테이블(sn_install_base_sold_product 아님)을 사용하는 경우 쿼리할 확장된 테이블의 이름입니다. 데이터 유형: 문자열 기본값: sn_install_base_sold_product | | sysparm_limit | 반환할 최대 기록 수입니다. 이 기록 수를 초과하는 요청의 경우 sysparm_offset 매개변수를 사용하여 기록 검색을 페이지 매김합니다. 이 제한은 ACL 평가 전에 적용됩니다. 액세스할 수 있는 기록을 포함하여 반환되는 기록이 없으면 액세스할 수 있는 기록이 먼저 반환되도록 기록 순서를 다시 정렬합니다. 주: 이례적으로 큰 sysparm_limit 값은 시스템 성능에 영향을 미칠 수 있습니다. 데이터 유형: 숫자 기본값: 10000 | | sysparm_offset | 기록 검색을 시작할 시작 기록 인덱스입니다. 이 값을 사용하여 기록 검색을 페이지 매김합니다. 이 기능을 사용하면 기록 수와 관계없이 관리 가능한 작은 청크로 모든 기록을 검색할 수 있습니다. 예를 들어 이 엔드포인트를 처음 호출할 때 sysparm_offset이 "0"으로 설정됩니다. 사용 가능한 모든 기록을 간단히 살펴보려면 모든 기록이 끝날 때까지 `sysparm_offset=sysparm_offset+sysparm_limit`를 사용합니다.{#integrat-GET-soldproducts__sysparm_offset-p-RESTAPI} 매개 변수에 sysparm_offset 음수를 전달하지 마세요. 데이터 유형: 숫자 기본값: 0 | [표 56. 쿼리 매개변수] {#integrat-GET-soldproducts__entry__18} | 이름 | 설명 | |-|-| | 없음 | | [표 57. 요청 본문 매개변수(XML 또는 JSON)] ### 헤더 다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 [지원되는 REST API 헤더를](https://servicenow-prod.fluidtopics.net/JHL64oGR2SkU25ZTkfHy7g "REST(REpresentational State Transfer)는 웹상의 컴퓨터 시스템 간에 표준을 제공하여 서로 보다 쉽게 통신할 수 있게 지원하는 단순한 상태 비저장 아키텍처입니다.") 참조하세요. {#integrat-GET-soldproducts__entry__22}{#integrat-GET-soldproducts__accept-RESTAPI} | 헤더 | 설명 | |-|-| | 수용 | 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json | [표 58. 요청 헤더] {#integrat-GET-soldproducts__entry__26} | 헤더 | 설명 | |-|-| | 없음 | | [표 59. 응답 헤더] ### 상태 코드 다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 [REST API HTTP 응답 코드를](https://servicenow-prod.fluidtopics.net/JHL64oGR2SkU25ZTkfHy7g "REST(REpresentational State Transfer)는 웹상의 컴퓨터 시스템 간에 표준을 제공하여 서로 보다 쉽게 통신할 수 있게 지원하는 단순한 상태 비저장 아키텍처입니다.") 참조하세요. {#integrat-GET-soldproducts__entry__30}{#integrat-GET-soldproducts__entry-200-status-code}{#integrat-GET-soldproducts__entry-400-status-code}{#integrat-GET-soldproducts__entry-403-status-code}{#integrat-GET-soldproducts__entry-404-status-code}{#integrat-GET-soldproducts__entry-500-status-code} | 상태 코드 | 설명 | |-|-| | 200 | 성공입니다. 요청이 성공적으로 처리되었습니다. | | 400 | 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다. | | 403 | 금지되었습니다. 사용자에게 지정된 기록에 대한 액세스 권한이 없습니다. | | 404 | 찾을 수 없습니다. 요청한 항목을 찾을 수 없습니다. | | 500 | 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다. | [표 60. 상태 코드] ### 응답 본문 매개변수(JSON 또는 XML) {#integrat-GET-soldproducts__entry__42}{#integrat-GET-soldproducts__error-integration-entry}{#integrat-GET-soldproducts__error_detail-integration-entry}{#integrat-GET-soldproducts__error_message-integration-entry}{#integrat-GET-soldproducts__has_more-integration-entry}{#integrat-GET-soldproducts__status-integration-entry}{#integrat-GET-soldproducts__sysparm_limit-integration-entry}{#integrat-GET-soldproducts__sysparm_offset-integration-entry} | 이름 | 설명 | |-|-| | 오류 | 요청을 처리하려고 할 때 발생한 오류에 대한 상세 정보입니다. 데이터 유형: 객체 "error": { "detail": "String", "message": "String" } | | 오류.상세 정보 | 관련 오류에 대한 추가 정보입니다. 데이터 유형: 문자열 | | 오류.메시지 | 요청을 실행하려고 할 때 발생한 문제를 설명하는 오류 메시지입니다. 데이터 유형: 문자열 | | has_more | 테이블에 반환할 기록이 더 있는지 여부를 나타내는 플래그입니다. 가능한 값: * true: 반환할 레코드가 더 많습니다. * false: 더 이상 반환할 기록이 없습니다. 데이터 형식: 부울 문자열 | | 판매된제품 | 지정된 설치 기반 항목 기록과 연결된 판매된 제품의 목록입니다. 데이터 형식: 객체 배열 "soldproducts":[ { "account": {Object}, "contact": {Object}, "name": "String", "number": "String", "product": {Object}, "sys_class_name": "String", "sys_id": "String", "state": {Object} } ] | | soldproducts.계정 | 제품 기록과 연결된 계정에 대한 상세 정보입니다. 데이터 유형: 객체 account": { "display_value": "String", "sys_id": "String" } | | soldproducts.account.display_value | 제품 기록과 연결된 계정의 텍스트 이름입니다. 이 값을 사용하여 UI에 계정 이름을 표시합니다. 데이터 유형: 문자열 | | soldproducts.account.sys_id | 제품 기록과 연결된 계정 기록의 Sys_id입니다. 데이터 유형: 문자열 | | 판매된제품.연락처 | 제품을 담당하는 계정 접촉 창구에 대한 상세 정보입니다. 데이터 유형: 객체 "contact": { "display_value": "String", "sys_id": "String" } | | soldproducts.contact.display_value | 제품과 관련된 접촉 창구의 텍스트 이름입니다. 이 값을 사용하여 UI에 연락처 이름을 표시합니다. 데이터 유형: 문자열 | | soldproducts.contact.sys_id | 제품 기록과 연결된 연락처 기록의 Sys_id입니다. 데이터 유형: 문자열 | | soldproducts.name | 제품의 이름입니다. 데이터 유형: 문자열 | | 판매된 제품.번호 | 제품 번호. 데이터 유형: 문자열 | | soldproducts.sys_클래스_이름 | 제품 기록이 포함된 테이블입니다. 데이터 유형: 문자열 | | soldproducts.sys_id | 연결된 제품의 Sys_id입니다. 데이터 유형: 문자열 | | soldproducts.상태 | 제품의 현재 상태에 대한 상세 정보입니다. 데이터 유형: 객체 "state": { "display_value": "String", "value": "String" } | | soldproducts.state.display_value | 제품의 현재 상태에 대한 텍스트 문자열입니다. 이 값을 사용하여 UI에 상태를 표시합니다. 데이터 유형: 문자열 | | soldproducts.state.value | 제품 상태에 대한 내부 값입니다. 데이터 유형: 문자열 | | 상태 | 엔드포인트 호출의 상태입니다. 데이터 유형: 문자열 | | sysparm_limit | 반환된 기록 수입니다. 이 값이 원래 요청에 지정되지 않은 경우 기본값이 사용됩니다. 데이터 유형: 숫자 | | sysparm_offset | 기록이 평가 및 검색된 관련 테이블의 오프셋(시작 지점)입니다. 데이터 유형: 문자열 | [ ] ### cURL 요청 다음 코드 예제에서는 이 끝점을 호출하는 방법을 보여 줍니다. curl "https://instance.servicenow.com/api/sn_install_base/integrations/installbaseitems/f77c7542b7343300ece839a6ee11a991/soldproducts?sysparm_limit=1" \ --request GET \ --header "Accept:application/json" \ --user 'username':'password' 반환 결과: { "result": { "sysparm_offset": 0, "sysparm_limit": 1, "has_more": true, "soldproducts": [ { "product": { "sys_id": "a9a2d0c3c6112276010db16c5ddd3461", "display_value": "Lenovo ThinkStation S20" }, "sys_class_name": "sn_install_base_sold_product", "number": "SLPRD0001008", "sys_id": "17a3a7128729a1105d0055373cbb35fb", "contact": { "sys_id": "ddce70866f9331003b3c498f5d3ee417", "display_value": "George Warren" }, "name": "SP B2B", "state": { "value": "active", "display_value": "Active" }, "account": { "sys_id": "86837a386f0331003b3c498f5d3ee4ca", "display_value": "Boxeo" } } ], "status": "SUCCESS" } } ## 설치 기반 항목 - GET /sn_install_base/integrations/installbaseitems/{id}/workorders {#ariaid-title12} 지정된 설치 기반 항목 기록과 연결된 작업 주문을 반환합니다.
### URL 형식 버전이 지정된 URL: /api/sn_install_base/{api_version}/integrations/installbaseitems/{id}/workorders 기본 URL: /api/sn_install_base/integrations/installbaseitems/{id}/workorders ### 지원되는 요청 매개변수 {#integrat-GET-workorders__entry__2}{#integrat-GET-workorders__version-RESTAPI}{#integrat-GET-workorders__integrate-id-entry} | 이름 | 설명 | |-|-| | api_version | 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열 | | id | 설치 기반 항목 기록의 Sys_id입니다. 설치 기반 항목 \[sn_install_base_item\] 테이블에 있습니다. 데이터 유형: 문자열 | [표 61. 경로 매개변수] {#integrat-GET-workorders__entry__8}{#integrat-GET-workorders__sysparm_offset-ph-RESTAPI} | 이름 | 설명 | |-|-| | 필드 이름-값 쌍 | 관련 당사자 기록을 필터링하는 데 사용할 필드-값 쌍입니다. 기본적으로 이는 판매된 제품 \[sn_install_base_sold_product\] 테이블의 필드를 참조합니다. 에서 sys_class_name다른 테이블을 지정하는 경우 해당 테이블의 필드를 지정합니다. 하나 이상의 필드-값 쌍을 전달하여 반환 결과를 필터링할 수 있습니다. 예를 들어 특정 계정에 판매된 제품을 필터링하려면 전달된 값이 계정의 sys_id인 `&account=86837a386f0331003b3c498f5d3ee4ca`와 유사한 값을 전달합니다. 데이터 유형: 문자열 기본값: 모든 필드 | | sys_class_name | 확장된 판매 제품 테이블(sn_install_base_sold_product 아님)을 사용하는 경우 쿼리할 확장된 테이블의 이름입니다. 데이터 유형: 문자열 기본값: sn_install_base_sold_product | | sysparm_limit | 반환할 최대 기록 수입니다. 이 기록 수를 초과하는 요청의 경우 매개변수를 sysparm_offset 사용하여 기록 검색을 페이지 매김합니다. 주: 이례적으로 큰 sysparm_limit 값은 시스템 성능에 영향을 미칠 수 있습니다. 데이터 유형: 숫자 기본값: 10 | | sysparm_offset | 기록 검색을 시작할 시작 기록 인덱스입니다. 이 값을 사용하여 기록 검색을 페이지 매김합니다. 이 기능을 사용하면 기록 수와 관계없이 관리 가능한 작은 청크로 모든 기록을 검색할 수 있습니다. 예를 들어 이 엔드포인트를 처음 호출할 때 sysparm_offset이 "0"으로 설정됩니다. 사용 가능한 모든 기록을 간단히 살펴보려면 모든 기록이 끝날 때까지 `sysparm_offset=sysparm_offset+sysparm_limit`를 사용합니다.{#integrat-GET-workorders__sysparm_offset-p-RESTAPI} 매개 변수에 sysparm_offset 음수를 전달하지 마세요. 데이터 유형: 숫자 기본값: 0 | [표 62. 쿼리 매개변수] {#integrat-GET-workorders__entry__18} | 이름 | 설명 | |-|-| | 없음 | | [표 63. 요청 본문 매개변수(XML 또는 JSON)] ### 헤더 다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 [지원되는 REST API 헤더를](https://servicenow-prod.fluidtopics.net/JHL64oGR2SkU25ZTkfHy7g "REST(REpresentational State Transfer)는 웹상의 컴퓨터 시스템 간에 표준을 제공하여 서로 보다 쉽게 통신할 수 있게 지원하는 단순한 상태 비저장 아키텍처입니다.") 참조하세요. {#integrat-GET-workorders__entry__22}{#integrat-GET-workorders__accept-RESTAPI} | 헤더 | 설명 | |-|-| | 수용 | 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json | [표 64. 요청 헤더] {#integrat-GET-workorders__entry__26} | 헤더 | 설명 | |-|-| | 없음 | | [표 65. 응답 헤더] ### 상태 코드 다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 [REST API HTTP 응답 코드를](https://servicenow-prod.fluidtopics.net/JHL64oGR2SkU25ZTkfHy7g "REST(REpresentational State Transfer)는 웹상의 컴퓨터 시스템 간에 표준을 제공하여 서로 보다 쉽게 통신할 수 있게 지원하는 단순한 상태 비저장 아키텍처입니다.") 참조하세요. {#integrat-GET-workorders__entry__30}{#integrat-GET-workorders__entry-200-status-code}{#integrat-GET-workorders__entry-400-status-code}{#integrat-GET-workorders__entry-403-status-code}{#integrat-GET-workorders__entry-404-status-code}{#integrat-GET-workorders__entry-500-status-code} | 상태 코드 | 설명 | |-|-| | 200 | 성공입니다. 요청이 성공적으로 처리되었습니다. | | 400 | 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다. | | 403 | 금지되었습니다. 사용자에게 지정된 기록에 대한 액세스 권한이 없습니다. | | 404 | 찾을 수 없습니다. 요청한 항목을 찾을 수 없습니다. | | 500 | 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다. | [표 66. 상태 코드] ### 응답 본문 매개변수(JSON 또는 XML) {#integrat-GET-workorders__entry__42}{#integrat-GET-workorders__error-integration-entry}{#integrat-GET-workorders__error_detail-integration-entry}{#integrat-GET-workorders__error_message-integration-entry}{#integrat-GET-workorders__has_more-integration-entry}{#integrat-GET-workorders__status-integration-entry}{#integrat-GET-workorders__sysparm_limit-integration-entry}{#integrat-GET-workorders__sysparm_offset-integration-entry} | 이름 | 설명 | |-|-| | 오류 | 요청을 처리하려고 할 때 발생한 오류에 대한 상세 정보입니다. 데이터 유형: 객체 "error": { "detail": "String", "message": "String" } | | 오류.상세 정보 | 관련 오류에 대한 추가 정보입니다. 데이터 유형: 문자열 | | 오류.메시지 | 요청을 실행하려고 할 때 발생한 문제를 설명하는 오류 메시지입니다. 데이터 유형: 문자열 | | has_more | 테이블에 반환할 기록이 더 있는지 여부를 나타내는 플래그입니다. 가능한 값: * true: 반환할 레코드가 더 많습니다. * false: 더 이상 반환할 기록이 없습니다. 데이터 형식: 부울 문자열 | | 상태 | 엔드포인트 호출의 상태입니다. 데이터 유형: 문자열 | | sysparm_limit | 반환된 기록 수입니다. 이 값이 원래 요청에 지정되지 않은 경우 기본값이 사용됩니다. 데이터 유형: 숫자 | | sysparm_offset | 기록이 평가 및 검색된 관련 테이블의 오프셋(시작 지점)입니다. 데이터 유형: 문자열 | | 작업 주문 | 지정된 설치 기반 항목 기록과 연결된 작업 주문의 목록입니다. 데이터 형식: 객체 배열 "workorders":[ { "active": "String", "approval": {Object}, "billable": "String", "escalation": "String", "has_appointment": "String", "hierarchical_variables": "String", "impact": "String", "install_base_item": {Object}, "is_catalog": "String", "knowledge": "String", "location": {Object}, "made_sla": "String", "needs_attention": "String", "number": "String", "opened_at": {Object}, "opened_by": {Object}, "opened_for": {Object}, "priority": "String", "reassignment_count": "String", "reschedule_maintenance_if_canceled": "String", "short_description": "String", "sla_suspended": "String", "state": "String", "sys_class_name": "String", "sys_domain_path": "String" "sys_id": "String", "task_created": "String", "task_effective_number": "String", "template_workflow_invoked": "String", "upon_approval": {Object}, "upon_reject": {Object}, "urgency": "String" } ] | | 작업 주문.활성 | 작업 주문이 활성 상태인지 여부를 나타내는 플래그입니다. 가능한 값: * true: 작업 주문이 활성 상태입니다. * false: 작업 주문이 비활성 상태입니다. 데이터 형식: 부울 문자열 | | 작업 주문.승인 | 작업 주문의 현재 승인 프로세스에 대한 상세 정보입니다. 데이터 유형: 객체 "approval": { "display_value": "String", "value": "String" } | | 작업 주문approval.display_value | 승인 프로세스의 현재 상태에 대한 텍스트 문자열입니다. 이 값을 사용하여 UI에 승인 상태를 표시합니다. 데이터 유형: 문자열 | | 작업 주문승인.값 | 승인 프로세스 상태의 내부 값입니다. 데이터 유형: 문자열 | | 작업 주문청구 | 작업 주문이 청구 가능한지 여부를 나타내는 플래그입니다. 가능한 값: * true: 작업 주문이 청구 가능합니다. * false: 작업 주문이 청구되지 않음 {#integrat-GET-workorders__ul_ign_q2w_4xb} 데이터 형식: 부울 문자열 | | 작업 주문에스컬레이션 | 작업 주문의 에스컬레이션 수준입니다. 데이터 유형: 문자열 | | 작업 주문has_appointment | 작업 주문에 예약된 약속이 있는지 여부를 나타내는 플래그입니다. 가능한 값: * true: 작업 주문에 약속이 있습니다. * false: 작업 주문에 약속이 없습니다. 데이터 형식: 부울 문자열 | | 작업 주문install_base_item | 작업 주문 기록과 연결된 설치 기반 항목에 대한 상세 정보입니다. 데이터 유형: 객체 "install_base_item": { "display_value": "String", "sys_id": "String" } | | 작업 주문install_base_item.display_value | 작업 주문 기록과 연결된 설치 기반 항목의 텍스트 이름입니다. 이 값을 사용하여 UI에 설치 기반 항목 이름을 표시합니다. 데이터 유형: 문자열 | | 작업 주문install_base_item.sys_id | 작업 주문 기록과 연결된 설치 기반 항목 기록의 Sys_id입니다. 데이터 유형: 문자열 | | 작업 주문is_catalog | 가 카탈로그에 속하는지 여부를 나타내는 플래그입니다. 가능한 값: * true: 작업 주문이 카탈로그의 일부입니다. * false: 작업 주문이 카탈로그의 일부가 아닙니다. 데이터 형식: 부울 문자열 | | 작업 주문.지식 | 지정된 작업 주문 문제에 사용할 수 있는 지식베이스 문서가 있는지 나타내는 플래그입니다. 가능한 값: * true: 이 문제에 대한 지식베이스 문서를 사용할 수 있습니다. * false: 이 문제에 대한 지식베이스 문서를 사용할 수 없습니다. 데이터 형식: 부울 문자열 | | 작업 주문.위치 | 작업해야 하는 항목의 위치에 대한 상세 정보입니다. 데이터 유형: 객체 "location": { "display_value": "String", "sys_id": "String" } | | 작업 주문위치.display_value | 작업할 항목 위치의 텍스트 이름입니다. 이 값을 사용하여 UI에 위치를 표시합니다. 데이터 유형: 문자열 | | 작업 주문위치.sys_id | 작업 주문 기록과 연결된 위치 기록의 Sys_id입니다. 데이터 유형: 문자열 | | 작업 주문made_sla | 작업 주문과 관련된 작업이 관련 서비스 수준 계약(SLA)을 충족하는지 여부를 나타내는 플래그입니다. 가능한 값: * true: SLA가 충족되었습니다. * false: SLA가 충족되지 않았습니다. 데이터 형식: 부울 문자열 | | 작업 주문needs_attention | 이 작업 주문에 주의가 필요한지 여부를 나타내는 플래그입니다. 가능한 값: * true: 작업 주문에 주의가 필요합니다. * false: 작업 주문에 주의가 필요하지 않습니다. 데이터 형식: 부울 문자열 | | 작업 주문수 | 작업 주문을 식별하는 데 사용되는 고유 번호입니다. 데이터 유형: 문자열 | | 작업 주문opened_at | 작업 주문이 오픈된 시기에 대한 상세 정보입니다. 데이터 유형: 객체 "opened_at": { "display_value": "String", "value": "String" } | | 작업 주문opened_at.display_value | 작업 주문이 오픈된 날짜 및 시간입니다. 이 값을 사용하여 UI에 값을 표시합니다. 데이터 유형: 문자열 | | 작업 주문opened_at.값 | 작업 주문이 오픈된 날짜 및 시간입니다. 데이터 유형: 문자열 | | 작업 주문opened_by | 작업 주문을 연 사람에 대한 상세 정보입니다. 데이터 유형: 객체 "opened_by": { "display_value": "String", "sys_id": "String" } | | 작업 주문opened_by.display_value | 작업 주문을 연 사람의 텍스트 이름입니다. 이 값을 사용하여 UI에 이 이름을 표시합니다. 데이터 유형: 문자열 | | 작업 주문opened_by.sys_id | 작업 주문을 연 사람의 사용자 기록 Sys_id입니다. 데이터 유형: 문자열 | | workorders.opened_for | 작업 주문이 오픈된 사람에 대한 상세 정보입니다(사람과 opened_by 다른 경우). 데이터 유형: 객체 "opened_for": { "display_value": "String", "sys_id": "String" } | | 작업 주문opened_for.display_value | 작업 주문이 오픈된 사람의 텍스트 이름입니다. 이 값을 사용하여 UI에 이 이름을 표시합니다. 데이터 유형: 문자열 | | 작업 주문opened_for.sys_id | 작업 주문이 오픈된 사람의 사용자 기록 Sys_id입니다. 데이터 유형: 문자열 | | 작업 주문.우선순위 | 작업 주문의 우선순위입니다. 데이터 유형: 문자열 | | 작업 주문reassignment_count | 작업 주문의 진행을 담당하는 사람에게 작업 주문이 재할당된 횟수입니다. 데이터 유형: 문자열 | | 작업 주문reschedule_maintenance_if_canceled | 연결된 작업 주문이 취소된 경우 작업 일정을 조정해야 하는지 여부를 나타내는 플래그입니다. 가능한 값: * true: 작업 일정을 조정합니다. * false: 작업 일정을 조정하기 전에 확인합니다. 데이터 형식: 부울 문자열 | | 작업 주문short_description | 작업 주문과 관련된 작업을 설명하는 간단한 텍스트입니다. 데이터 유형: 문자열 | | 작업 주문sla_suspended | 작업 주문과 연관된 SLA가 일시 중단되었는지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. * true: SLA가 일시 중단되었습니다. * false: SLA가 일시 중단되지 않았습니다. 데이터 형식: 부울 문자열 | | 작업 주문.상태 | 작업 주문의 현재 상태입니다. 데이터 유형: 문자열 | | 작업 주문sys_class_name | 작업 주문 기록을 포함하는 테이블입니다. 데이터 유형: 문자열 | | 작업 주문sys_domain_path | 도메인 경로입니다. 데이터 유형: 문자열 | | workorders.sys_id | 연결된 작업 주문 기록의 Sys_id입니다. 데이터 유형: 문자열 | | 작업 주문task_created | 이 작업 주문에 대해 작업이 생성되었는지 여부를 나타내는 플래그입니다. 가능한 값: * true: 이 작업 주문에 대한 작업이 작성되었습니다. * false: 이 작업 주문에 대한 작업이 생성되지 않았습니다. 데이터 형식: 부울 문자열 | | 작업 주문task_effective_number | 작업 주문을 식별하는 데 사용되는 고유 번호입니다. 데이터 유형: 문자열 | | 작업 주문template_workflow_invoked | 이 작업 주문에 대해 관련 워크플로우가 호출되었는지 여부를 나타내는 플래그입니다. 가능한 값: * true: 워크플로우가 호출되었습니다. * false: Worflow가 호출되지 않았습니다. 데이터 형식: 부울 문자열 | | 작업 주문upon_approval | 작업 주문이 승인되면 수행할 다음 작업에 대한 상세 정보입니다. 데이터 유형: 객체 "upon_approval": { "display_value": "String", "value": "String" } | | 작업 주문upon_approval.display_value | 작업 주문이 승인될 경우 수행할 작업의 텍스트 문자열입니다. 이 값을 사용하여 UI에 이 정보를 표시합니다. 데이터 유형: 문자열 | | 작업 주문upon_approval.값 | 작업 주문이 승인되면 수행할 동작입니다. 가능한 값: * do_nothing * 진행 데이터 유형: 문자열 | | 작업 주문upon_reject | 작업 주문이 거부될 경우 수행할 다음 조치에 대한 상세 정보입니다. 데이터 유형: 객체 "upon_reject": { "display_value": "String", "value": "String" } | | 작업 주문upon_reject.display_value | 작업 주문이 거부될 경우 수행할 작업의 텍스트 문자열입니다. 이 값을 사용하여 UI에 이 정보를 표시합니다. 데이터 유형: 문자열 | | 작업 주문upon_reject.값 | 작업 주문이 거부될 경우 수행할 동작입니다. 가능한 값: * cancel * goto 데이터 유형: 문자열 | | 작업 주문.긴급도 | 작업 주문의 긴급도입니다. 데이터 유형: 문자열 | [ ] ### cURL 요청 다음 코드 예제에서는 이 끝점을 호출하는 방법을 보여 줍니다. curl "https://instance.servicenow.com/api/sn_install_base/integrations/installbaseitems/f77c7542b7343300ece839a6ee11a991/workorders?sysparm_limit=1" \ --request GET \ --header "Accept:application/json" \ --user 'username':'password' 반환 결과: { "result": { "sysparm_offset": 0, "sysparm_limit": 10, "has_more": false, "workorders": [ { "upon_reject": { "value": "cancel", "display_value": "Cancel all future Tasks" }, "number": "WO0010372", "state": "1", "template_workflow_invoked": "false", "knowledge": "false", "impact": "3", "active": "true", "priority": "4", "sys_domain_path": "/", "sla_suspended": "false", "needs_attention": "false", "short_description": "Test WO1", "sys_class_name": "wm_order", "reschedule_maintenance_if_canceled": "true", "reassignment_count": "0", "hierarchical_variables": "variable_pool", "opened_for": { "sys_id": "85453c616fc331003b3c498f5d3ee4fa", "display_value": "Jodi Seals" }, "install_base_item": { "sys_id": "42746a3b876121100b6afc86dabb3597", "display_value": "KX Series - KX5000" }, "has_appointment": "false", "escalation": "0", "upon_approval": { "value": "proceed", "display_value": "Proceed to Next Task" }, "spam": "false", "made_sla": "true", "is_catalog": "false", "task_effective_number": "WO0010372", "opened_by": { "sys_id": "85453c616fc331003b3c498f5d3ee4fa", "display_value": "Jodi Seals" }, "opened_at": { "value": "2023-03-20 13:33:22", "display_value": "2023-03-20 06:33:22" }, "task_created": "false", "sys_id": "19761cc087b521100b6afc86dabb352f", "urgency": "3", "approval": { "value": "not requested", "display_value": "Not Yet Requested" }, "billable": "false", "location": { "sys_id": "1cd145bc23070110766713d1d7bf654f", "display_value": "2866 Stevens Creek Blvd,Santa Clara,CA" } } ], "status": "SUCCESS" } } ## 설치 기반 항목 - PATCH /sn_install_base/integrations/installbaseitems/{id} {#ariaid-title13} 지정된 필드 값으로 지정된 설치 기반 항목 기록을 업데이트합니다. ### URL 형식 버전이 지정된 URL: /api/sn_install_base/{api_version}/integrations/installbaseitems/{id} 기본 URL: /api/sn_install_base/integrations/installbaseitems/{id} ### 지원되는 요청 매개변수 {#integrat-PATCH-installbaseitems__entry__2}{#integrat-PATCH-installbaseitems__version-RESTAPI} | 이름 | 설명 | |-|-| | api_version | 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열 | [표 67. 경로 매개변수] {#integrat-PATCH-installbaseitems__entry__6} | 이름 | 설명 | |-|-| | 없음 | | [표 68. 쿼리 매개변수] {#integrat-PATCH-installbaseitems__id_x5m_53g_xwb__entry__2}{#integrat-PATCH-installbaseitems__account-request-integration-entry}{#integrat-PATCH-installbaseitems__active-request-integration-entry}{#integrat-PATCH-installbaseitems__asset-request-integration-entry}{#integrat-PATCH-installbaseitems__child_install_base_items-request-integration-entry}{#integrat-PATCH-installbaseitems__child_install_base_items_name-request-integration-entry}{#integrat-PATCH-installbaseitems__child_install_base_items_product-request-integration-entry}{#integrat-PATCH-installbaseitems__configuration_item-request-integration-entry}{#integrat-PATCH-installbaseitems__consumer-request-integration-entry}{#integrat-PATCH-installbaseitems__consumer_profile-request-integration-entry}{#integrat-PATCH-installbaseitems__contact-request-integration-entry}{#integrat-PATCH-installbaseitems__household-request-integration-entry}{#integrat-PATCH-installbaseitems__install_date-request-integration-entry}{#integrat-PATCH-installbaseitems__location-request-integration-entry}{#integrat-PATCH-installbaseitems__name-request-integration-entry}{#integrat-PATCH-installbaseitems__number-request-integration-entry}{#integrat-PATCH-installbaseitems__parent-request-integration-entry}{#integrat-PATCH-installbaseitems__product-request-integration-entry}{#integrat-PATCH-installbaseitems__quantity-request-integration-entry}{#integrat-PATCH-installbaseitems__service_context-request-integration-entry}{#integrat-PATCH-installbaseitems__service_organization-request-integration-entry}{#integrat-PATCH-installbaseitems__state-request-integration-entry}{#integrat-PATCH-installbaseitems__status-request-integration-entry}{#integrat-PATCH-installbaseitems__uninstall_date-request-integration-entry} | 이름 | 설명 | |-|-| | 계정 | 계정에 대한 설치 기반 항목을 생성할 때 필요합니다. 설치 기반 항목과 연결할 계정의 Sys_id입니다. 계정 \[customer_account\] 테이블에 있습니다. 주: 매개 변수를 전달 account 하면 매개 변수도 consumer 전달할 수 없습니다. 데이터 유형: 문자열 | | active | 설치 기반 항목이 활성 상태인지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. * true, "true" 또는 "0": 항목이 활성 상태입니다. * false, "false" 또는 "1": 항목이 활성 상태가 아닙니다. 데이터 유형: 부울 기본값: true | | asset | 설치 기반 항목 기록과 연결된 자산의 Sys_id입니다. 자산 \[alm_asset\] 테이블에 있습니다. 데이터 유형: 문자열 | | child_install_base_items | 이 설치 기반 항목과 연결된 하위 설치 기반 항목의 목록입니다. 주: 다음 하위 설치 기반 항목 필드는 상위 항목과 다를 수 없습니다. * 계정 * 소비자 * 연락처 * 서비스 조직 {#integrat-PATCH-installbaseitems__ul_fkz_s33_wxb} 데이터 형식: 객체 배열 "child_install_base_items": [ { "name": "String", "product": "String" } ] | | child_install_base_items.이름 | 하위 설치 기반 항목의 이름입니다. 데이터 유형: 문자열 | | child_install_base_items.제품 | 연결된 하위 기본 항목 기록의 Sys_id입니다. 설치 기반 항목 \[sn_install_base_item\] 테이블에 있습니다. 데이터 유형: 문자열 | | configuration_item | 설치 기반 항목 기록과 연결된 구성 항목의 Sys_id입니다. 구성 항목 \[cmdb_ci\] 테이블에 있습니다. 데이터 유형: 문자열 | | 소비자 | 소비자에 대한 설치 기반 항목을 만들 때 필요합니다. 설치 기반 항목 기록과 연결된 소비자의 Sys_id입니다. 소비자 \[csm_consumer\] 테이블에 있습니다. 주: 매개 변수를 전달 consumer 하면 매개 변수도 account 전달할 수 없습니다. 또한 B2B2C 플러그인이 인스턴스에 설치된 경우에만 소비자를 설치 기반 항목과 연결할 수 있습니다. 데이터 유형: 문자열 | | consumer_profile | 설치 기반 항목 기록과 연결된 소비자 프로필의 Sys_id입니다. 소비자 프로필 \[sn_csm_consumer_profile\] 테이블에 있습니다. 데이터 유형: 문자열 | | 연락처 | 설치 기반 항목을 1차적으로 담당하는 계정 접촉 창구 기록의 Sys_id입니다. 연락처 \[customer_contact\] 테이블에 있습니다. 주: 계정 설치 기반 항목에 대해서만 연락처를 지정할 수 있습니다. 데이터 유형: 문자열 | | household | 설치 기반 항목 기록과 연결된 세대 Sys_id입니다. 세대\[csm_household\] 테이블에 있습니다. 주: 이 필드는 Customer Service Household(com.snc.household) 플러그인이 설치된 경우에만 유효합니다. 데이터 유형: 문자열 | | install_date | 설치 기반 항목이 활성 상태가 된 날짜입니다. 데이터 유형: 문자열 형식: yyyy-MM-dd HH:mm:ss | | 위치 | 연결된 제품 위치의 Sys_id입니다. 위치 \[cmn_location\] 테이블에 있습니다. 데이터 유형: 문자열 | | 이름 | 설치 기반 항목의 이름입니다. 데이터 유형: 문자열 | | 번호 | 설치 기반 항목의 고유 식별자입니다. 데이터 유형: 문자열 기본값: 엔드포인트에서 자동으로 생성됩니다. | | 상위 | 이 설치 기반 항목 기록의 상위 기록 Sys_id입니다. 설치 기반 항목 \[sn_install_base_item\] 테이블에 있습니다. 데이터 유형: 문자열 | | product_model | 설치 기반 항목 기록과 연결된 제품 모델의 Sys_id입니다. 제품 모델 \[cmdb_model\] 테이블에 있습니다. 데이터 유형: 문자열 | | 수량 | 설치된 항목 수입니다. 데이터 형식: 정수 | | service_context | 이벤트 관리에서 영향 심각도를 계산하기 위해 기본 CI와 연결된 서비스 Sys_id입니다. 자세한 내용은 [Service health status for install base](https://www.servicenow.com/docs/access?context=service-health-pcso&version=xanadu&pubname=xanadu-customer-service-management&ft:locale=en-US) 문서를 참조하십시오. 주: 이 필드는 이벤트 관리를 포함한 사전 예방적 고객 서비스 운영 플러그인이 설치된 경우에만 유효합니다. 데이터 유형: 문자열 | | service_organization | 서비스 조직에 대한 설치 기반 항목을 생성할 때 필요합니다. 고객에게 서비스를 제공하는 데 관여하는 서비스 조직 기록의 Sys_id입니다. 서비스 조직 \[sn_customer_service_organization\] 테이블에 있습니다. 주: 이 매개 변수를 전달하는 경우 계정, 연락처 또는 소비자 매개 변수도 전달해서는 안 됩니다. 이 service_organization 매개변수는 인스턴스에 Service Organization(com.snc.service_organization) 플러그인이 설치된 경우에만 사용할 수 있습니다. 데이터 유형: 문자열 | | 상태 | 설치 기반 항목의 현재 상태입니다. 유효한 값은 다음과 같습니다. * in_use * 비활성 데이터 유형: 문자열 | | 상태 | 제품의 상태입니다. 유효한 값은 다음과 같습니다. * 원본 * 교체 데이터 유형: 문자열 | | sys_class_name | 설치 기반 항목 기록을 업데이트할 확장 설치 기반 테이블의 이름입니다. 데이터 유형: 문자열 | | uninstall_date | 설치 기반이 비활성 상태가 된 날짜입니다. 데이터 유형: 문자열 형식: yyyy-MM-dd HH:mm:ss | [표 69. 요청 본문 매개변수(XML 또는 JSON)] {#integrat-PATCH-installbaseitems__id_x5m_53g_xwb} ### 헤더 다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 [지원되는 REST API 헤더를](https://servicenow-prod.fluidtopics.net/JHL64oGR2SkU25ZTkfHy7g "REST(REpresentational State Transfer)는 웹상의 컴퓨터 시스템 간에 표준을 제공하여 서로 보다 쉽게 통신할 수 있게 지원하는 단순한 상태 비저장 아키텍처입니다.") 참조하세요. {#integrat-PATCH-installbaseitems__entry__60}{#integrat-PATCH-installbaseitems__accept-RESTAPI}{#integrat-PATCH-installbaseitems__content_type-RESTAPI} | 헤더 | 설명 | |-|-| | 수용 | 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json | | 컨텐츠-형식 | 요청 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json | [표 70. 요청 헤더] {#integrat-PATCH-installbaseitems__entry__66} | 헤더 | 설명 | |-|-| | 없음 | | [표 71. 응답 헤더] ### 상태 코드 다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 [REST API HTTP 응답 코드를](https://servicenow-prod.fluidtopics.net/JHL64oGR2SkU25ZTkfHy7g "REST(REpresentational State Transfer)는 웹상의 컴퓨터 시스템 간에 표준을 제공하여 서로 보다 쉽게 통신할 수 있게 지원하는 단순한 상태 비저장 아키텍처입니다.") 참조하세요. {#integrat-PATCH-installbaseitems__entry__70}{#integrat-PATCH-installbaseitems__entry-200-status-code}{#integrat-PATCH-installbaseitems__entry-400-status-code}{#integrat-PATCH-installbaseitems__entry-403-status-code}{#integrat-PATCH-installbaseitems__entry-404-status-code}{#integrat-PATCH-installbaseitems__entry-500-status-code} | 상태 코드 | 설명 | |-|-| | 200 | 성공입니다. 요청이 성공적으로 처리되었습니다. | | 400 | 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다. | | 403 | 금지되었습니다. 사용자에게 지정된 기록에 대한 액세스 권한이 없습니다. | | 404 | 찾을 수 없습니다. 요청한 항목을 찾을 수 없습니다. | | 500 | 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다. | [표 72. 상태 코드] ### 응답 본문 매개변수(JSON 또는 XML) {#integrat-PATCH-installbaseitems__id_zk1_w5w_ywb__entry__2}{#integrat-PATCH-installbaseitems__error-integration-entry}{#integrat-PATCH-installbaseitems__error_detail-integration-entry}{#integrat-PATCH-installbaseitems__error_message-integration-entry} | 이름 | 설명 | |-|-| | 오류 | 요청을 처리하려고 할 때 발생한 오류에 대한 상세 정보입니다. 데이터 유형: 객체 "error": { "detail": "String", "message": "String" } | | 오류.상세 정보 | 관련 오류에 대한 추가 정보입니다. 데이터 유형: 문자열 | | 오류.메시지 | 요청을 실행하려고 할 때 발생한 문제를 설명하는 오류 메시지입니다. 데이터 유형: 문자열 | | 항목 | 업데이트된 설치 기반 항목에 대한 세부 정보입니다. 데이터 유형: 객체 "item": { "account": {Object}, "active": Boolean, "name": "String", "number": "String", "state": {Object}, "sys_class_name": {Object}, "sys_id": "String" } | | item.account | 설치 기반 항목 기록과 연결된 고객 계정에 대한 세부 정보입니다. 데이터 유형: 객체 "account": { "display_value": "String", "sys_id": "String" } | | item.account.display_value | 설치 기반 항목 기록과 연결된 고객 계정의 텍스트 이름입니다. 이 값을 사용하여 UI에 고객 계정 이름을 표시합니다. 데이터 유형: 문자열 | | item.account.sys_id | 설치 기반 항목 기록과 연결된 고객 계정 기록의 Sys_id입니다. 데이터 유형: 문자열 | | item.active | 설치 기반 항목이 활성 상태인지 여부를 나타내는 플래그입니다. 가능한 값: * true: 설치 기반 항목이 활성 상태입니다. * false: 설치 기반 항목이 비활성 상태입니다. 데이터 유형: 부울 문자열 | | item.name | 설치 기반 항목의 이름입니다. 데이터 유형: 문자열 | | item.number | 설치 기반 항목의 고유 ID입니다. 데이터 유형: 문자열 | | item.state | 설치 기반 항목의 현재 상태에 대한 세부 정보입니다. 데이터 유형: 객체 "state": { "display_value": "String", "value": "String" } | | item.state.display_value | 설치 기반 항목의 현재 상태에 대한 텍스트 문자열입니다. 이 값을 사용하여 UI에 상태를 표시합니다. 데이터 유형: 문자열 | | item.state.value | 설치 기반 항목의 상태에 대한 내부 값입니다. 데이터 유형: 문자열 | | item.sys_클래스_이름 | 설치 기반 항목이 포함된 테이블에 대한 세부 정보입니다. 데이터 유형: 객체 "sys_class_name": { "display_value": "String", "value": "String" } | | item.sys_class_name.display_value | 설치 기반 항목을 포함하는 테이블 이름의 텍스트 문자열입니다. 이 값을 사용하여 UI에 테이블 이름을 표시합니다. 데이터 유형: 문자열 | | item.sys_class_name.value | 설치 기반 항목을 포함하는 테이블의 내부 값 데이터 유형: 문자열 | | item.sys_id | 설치 기반 항목 기록의 Sys_id입니다. 매개변수에 지정된 sys_class_name 테이블에 있습니다. 데이터 유형: 문자열 | | 상태 | 엔드포인트 호출의 상태입니다. 데이터 유형: 문자열 | [ ] {#integrat-PATCH-installbaseitems__id_zk1_w5w_ywb} ### cURL 요청 다음 코드 예제에서는 설치 기반 항목 레코드의 이름 및 활성 필드를 업데이트하는 방법을 보여 줍니다. curl "https://instance.servicenow.com/api/sn_install_base/integrations/installbaseitems/f77c7542b7343300ece839a6ee11a991" \ --request PATCH \ --header "Accept:application/json" \ --header "Content-Type:application/json" \ --data "{ \"name\": \"KX Series - KX5001\", \"active\":true }" \ --user 'username':'password' 반환 결과: { "result": { "status": "SUCCESS", "item": { "sys_class_name": { "value": "sn_install_base_item", "display_value": "Install Base Item" }, "number": "IBITM0001001", "sys_id": "bc610d38cb76211050501ebfe8076d8b", "state": { "value": "inactive", "display_value": "Inactive" }, "active": "false", "name": "NewTestIB", "account": { "sys_id": "8637a386f0331003b3c498f5d3ee4ca", "display_value": "Boxeo" } } } } } ## 설치 기반 항목 - PATCH /sn_install_base/integrations/installbaseitems/{id}/relatedparties/{related_party_sys_id} {#ariaid-title14} 지정된 설치 기반 항목과 연결된 지정된 관련 당사자 기록을 요청 본문의 값으로 업데이트합니다. 설치 기반 항목과 연결된 관련 당사자의 유형을 수정해야 하는 경우 현재 관련 당사자 유형의 유형별 필드를 제거하고 새 관련 당사자 유형의 유형별 필드로 대체해야 합니다. 예를 들어, 인증된 계정 유형에서 인증된 소비자로 변경하려면 다음을 전달합니다. * type = "인증된 소비자" * account = "" * consumer = "소비자 기록 \" * responsibility = "소비자의 책임 \" ### URL 형식 버전이 지정된 URL: /api/sn_install_base/{api_version}/integrations/installbaseitems/{id}/relatedparties/{related_party_sys_id} 기본 URL: /api/sn_install_base/integrations/installbaseitems/{id}/relatedparties/{related_party_sys_id} ### 지원되는 요청 매개변수 {#integrat-PATCH-relatedparties__entry__2}{#integrat-PATCH-relatedparties__version-RESTAPI}{#integrat-PATCH-relatedparties__integrate-id-entry}{#integrat-PATCH-relatedparties__related_party_sys_id-integrate-entry} | 이름 | 설명 | |-|-| | api_version | 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열 | | id | 설치 기반 항목 기록의 Sys_id입니다. 설치 기반 항목 \[sn_install_base_item\] 테이블에 있습니다. 데이터 유형: 문자열 | | related_party_sys_id | 관련 당사자 기록의 Sys_id입니다. 기본적으로 설치 기반 관련 당사자\[sn_install_base_related_party\] 테이블에 있습니다. 데이터 유형: 문자열 | [표 73. 경로 매개변수] {#integrat-PATCH-relatedparties__entry__10} | 이름 | 설명 | |-|-| | 없음 | | [표 74. 쿼리 매개변수] {#integrat-PATCH-relatedparties__entry__14}{#integrat-PATCH-relatedparties__account-request-integration-entry}{#integrat-PATCH-relatedparties__consumer-request-integration-entry}{#integrat-PATCH-relatedparties__service_organization-request-integration-entry} | 이름 | 설명 | |-|-| | 계정 | 매개변수가 type 다음 중 하나인 경우 필수입니다. * 인증된 계정 * 인증된 접촉 창구 * 목록에 있는 계정 * 접촉 창구 목록 설치 기반 항목과 연결할 계정의 Sys_id입니다. 계정 \[customer_account\] 테이블에 있습니다. 주: 매개 변수를 전달 account 하면 매개 변수도 consumer 전달할 수 없습니다. 데이터 유형: 문자열 | | 소비자 | 매개변수가 type인증된 소비자 또는 나열된 소비자인 경우 필수입니다. 설치 기반 항목 기록과 연결된 소비자의 Sys_id입니다. 소비자 \[csm_consumer\] 테이블에 있습니다. 주: 매개 변수를 전달 consumer 하면 매개 변수도 account 전달할 수 없습니다. 또한 B2B2C 플러그인이 인스턴스에 설치된 경우에만 소비자를 설치 기반 항목과 연결할 수 있습니다. 데이터 유형: 문자열 | | 연락처 | 관련 당사자 기록과 연결된 연락처 기록의 Sys_id입니다. 연락처 \[customer_contact\] 테이블에 있습니다. 데이터 유형: 문자열 | | 책임 | 연결된 책임 기록의 Sys_id입니다. 이 기록은 설치 기반 정보에 대한 액세스 수준을 정의합니다. 책임 정의 \[sn_customerservice_responsibility_def\] 테이블에 있습니다. 이 매개변수는 필드도 related_party 지정된 경우에만 유효합니다. 지정한 경우 및 responsibility 매개변수 모두 related_party 와 일치하는 설치 기반 항목만 반환합니다. 자세한 내용은 다음을 참조하십시오. [Configure related parties for items received](https://www.servicenow.com/docs/access?context=psds-add-related-parties-to-record&version=xanadu&pubname=xanadu-government-industry&ft:locale=en-US) 데이터 유형: 문자열 | | service_organization | 매개변수가 type 다음 중 하나인 경우 필수입니다. * 인증된 구성원 * 공인 서비스 조직 * 목록에 있는 구성원 * 목록에 있는 서비스 조직 고객에게 서비스를 제공하는 데 관여하는 서비스 조직 기록의 Sys_id입니다. 서비스 조직 \[sn_customer_service_organization\] 테이블에 있습니다. 주: 이 매개 변수를 전달하는 경우 계정, 연락처 또는 소비자 매개 변수도 전달해서는 안 됩니다. 이 service_organization 매개변수는 인스턴스에 Service Organization(com.snc.service_organization) 플러그인이 설치된 경우에만 사용할 수 있습니다. 데이터 유형: 문자열 | | sys_class_name | 관련 당사자 기록이 포함된 테이블입니다. 데이터 유형: 문자열 기본값: sn_install_base_related_party | | 유형 | 필수 작성할 관련 당사자 유형의 Sys_id입니다. 관련 당사자 구성 \[sn_customerservice_related_party_configuration\] 테이블에 있습니다. 가능한 유형: * 인증된 계정 * 인증된 소비자 * 인증된 접촉 창구 * 인증된 기고자 * 인증된 구성원 * 공인 서비스 조직 * 목록에 있는 계정 * 소비자 목록 * 접촉 창구 목록 * 목록에 있는 기고자 * 목록에 있는 구성원 * 목록에 있는 서비스 조직 데이터 유형: 문자열 | | 사용자 | 매개변수가 type 다음 관련 당사자 유형 중 하나인 경우 필수입니다. * 인증된 기고자 * 인증된 구성원 * 목록에 있는 기고자 * 목록에 있는 구성원 관련 당사자 기록과 연결된 사용자 기록의 Sys_id입니다. 사용자 \[sys_user\] 테이블에 있습니다. 데이터 유형: 문자열 인증된 구성원 및 나열된 구성원의 경우, 이 사용자는 지정된 service_organization 기록과 연결되어 있어야 합니다. | [표 75. 요청 본문 매개변수(XML 또는 JSON)] ### 헤더 다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 [지원되는 REST API 헤더를](https://servicenow-prod.fluidtopics.net/JHL64oGR2SkU25ZTkfHy7g "REST(REpresentational State Transfer)는 웹상의 컴퓨터 시스템 간에 표준을 제공하여 서로 보다 쉽게 통신할 수 있게 지원하는 단순한 상태 비저장 아키텍처입니다.") 참조하세요. {#integrat-PATCH-relatedparties__entry__32}{#integrat-PATCH-relatedparties__accept-RESTAPI}{#integrat-PATCH-relatedparties__content_type-RESTAPI} | 헤더 | 설명 | |-|-| | 수용 | 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json | | 컨텐츠-형식 | 요청 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json | [표 76. 요청 헤더] {#integrat-PATCH-relatedparties__entry__38} | 헤더 | 설명 | |-|-| | 없음 | | [표 77. 응답 헤더] ### 상태 코드 다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 [REST API HTTP 응답 코드를](https://servicenow-prod.fluidtopics.net/JHL64oGR2SkU25ZTkfHy7g "REST(REpresentational State Transfer)는 웹상의 컴퓨터 시스템 간에 표준을 제공하여 서로 보다 쉽게 통신할 수 있게 지원하는 단순한 상태 비저장 아키텍처입니다.") 참조하세요. {#integrat-PATCH-relatedparties__entry__42}{#integrat-PATCH-relatedparties__entry-200-status-code}{#integrat-PATCH-relatedparties__entry-400-status-code}{#integrat-PATCH-relatedparties__entry-403-status-code}{#integrat-PATCH-relatedparties__entry-404-status-code}{#integrat-PATCH-relatedparties__entry-500-status-code} | 상태 코드 | 설명 | |-|-| | 200 | 성공입니다. 요청이 성공적으로 처리되었습니다. | | 400 | 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다. | | 403 | 금지되었습니다. 사용자에게 지정된 기록에 대한 액세스 권한이 없습니다. | | 404 | 찾을 수 없습니다. 요청한 항목을 찾을 수 없습니다. | | 500 | 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다. | [표 78. 상태 코드] ### 응답 본문 매개변수(JSON 또는 XML) {#integrat-PATCH-relatedparties__id_gls_y2f_zwb__entry__2}{#integrat-PATCH-relatedparties__error-integration-entry}{#integrat-PATCH-relatedparties__error_detail-integration-entry}{#integrat-PATCH-relatedparties__error_message-integration-entry}{#integrat-PATCH-relatedparties__status-integration-entry}{#integrat-PATCH-relatedparties__sysparm_limit-integration-entry}{#integrat-PATCH-relatedparties__sysparm_offset-integration-entry} | 이름 | 설명 | |-|-| | 오류 | 요청을 처리하려고 할 때 발생한 오류에 대한 상세 정보입니다. 데이터 유형: 객체 "error": { "detail": "String", "message": "String" } | | 오류.상세 정보 | 관련 오류에 대한 추가 정보입니다. 데이터 유형: 문자열 | | 오류.메시지 | 요청을 실행하려고 할 때 발생한 문제를 설명하는 오류 메시지입니다. 데이터 유형: 문자열 | | 항목 | 관련 당사자 기록에 대한 상세 정보입니다. 데이터 유형: 배열 "item": { "account": {Object}, "consumer": {Object}, "contact": {Object}, "install_base_item": {Object}, "responsibility": {Object}, "service_organization": {Object}, "sys_class_name": "String", "sys_id": "String", "type": {Object}, "user": {Object} } | | item.account | 관련 당사자 기록과 연결된 계정에 대한 상세 정보입니다. 데이터 유형: 객체 account": { "display_value": "String", "sys_id": "String" } | | item.account.display_value | 관련 당사자 기록과 연결된 계정의 텍스트 이름입니다. 이 값을 사용하여 UI에 계정 이름을 표시합니다. 데이터 유형: 문자열 | | item.account.sys_id | 관련 당사자 기록과 연결된 계정 기록의 Sys_id입니다. 데이터 유형: 문자열 | | item.consumer | 관련 당사자 기록과 연결된 소비자에 대한 상세 정보입니다. 데이터 유형: 객체 "consumer": { "display_value": "String", "sys_id": "String" } | | item.consumer.display_value | 관련 당사자 기록과 연결된 소비자의 텍스트 이름입니다. 이 값을 사용하여 UI에 소비자 이름을 표시합니다. 데이터 유형: 문자열 | | item.consumer.sys_id | 관련 당사자 기록과 연결된 소비자 기록의 Sys_id입니다. 데이터 유형: 문자열 | | item.contact | 관련 당사자 기록을 담당하는 계정 연락처에 대한 상세 정보입니다. 데이터 유형: 객체 "contact": { "display_value": "String", "sys_id": "String" } | | item.contact.display_value | 관련 당사자 기록과 연결된 연락처의 텍스트 이름입니다. 이 값을 사용하여 UI에 연락처 이름을 표시합니다. 데이터 유형: 문자열 | | item.contact.sys_id | 관련 당사자 기록과 연결된 연락처 기록의 Sys_id입니다. 연락처 \[customer_contact\] 테이블에 있습니다. 데이터 유형: 문자열 | | item.install_base_item | 관련 당사자 기록과 연결된 설치 기반 항목에 대한 상세 정보입니다. 데이터 유형: 객체 "install_base_item": { "display_value": "String", "sys_id": "String" } | | item.install_base_item.display_value | 관련 당사자 기록과 연결된 설치 기반 항목의 텍스트 이름입니다. 이 값을 사용하여 UI에 설치 기반 항목 이름을 표시합니다. 데이터 유형: 문자열 | | item.install_base_item.sys_id | 관련 당사자 기록과 연결된 설치 기반 항목 기록의 Sys_id입니다. 데이터 유형: 문자열 | | item.responsibility | 설치 기반 정보의 접근 수준에 대한 세부 정보입니다. 데이터 유형: 객체 "responsibility": { "display_value": "String", "sys_id": "String" } | | item.responsibility.display_value | 설치 기반 정보에 대한 접근 수준에 대한 텍스트 표시 값입니다. 데이터 유형: 문자열 | | item.responsibility.sys_id | 연결된 책임 기록의 Sys_id입니다. 이 기록은 설치 기반 정보에 대한 액세스 수준을 정의합니다. 책임 정의 \[sn_customerservice_responsibility_def\] 테이블에 있습니다. 이 매개변수는 필드도 related_party 지정된 경우에만 유효합니다. 지정한 경우 및 responsibility 매개변수 모두 related_party 와 일치하는 설치 기반 항목만 반환합니다. 자세한 내용은 다음을 참조하십시오. [Configure related parties for items received](https://www.servicenow.com/docs/access?context=psds-add-related-parties-to-record&version=xanadu&pubname=xanadu-government-industry&ft:locale=en-US) 데이터 유형: 문자열 | | item.sys_클래스_이름 | 관련 당사자 기록이 포함된 테이블입니다. 데이터 유형: 문자열 기본값: sn_install_base_related_party | | item.sys_id | 연결된 관련 당사자 기록의 Sys_id입니다. 데이터 유형: 문자열 | | item.type | 관련 당사자 기록과 연결된 연락처 유형에 대한 상세 정보입니다. 데이터 유형: 객체 "type": { "display_value": "String", "sys_id": "String" } | | item.type.display_value | 관련 당사자 기록과 연결된 연락처 유형의 텍스트 이름입니다. 이 값을 사용하여 UI에 연락처 유형을 표시합니다. 자세한 내용은 [Add related party configurations to cases, sold products, install bases, or service organizations](https://www.servicenow.com/docs/access?context=adding-related-party-config-to-case&version=xanadu&pubname=xanadu-customer-service-management&ft:locale=en-US) 문서를 참조하십시오. 가능한 유형: * 인증된 계정 * 인증된 소비자 * 인증된 접촉 창구 * 인증된 기고자 * 인증된 구성원 * 공인 서비스 조직 * 목록에 있는 계정 * 소비자 목록 * 접촉 창구 목록 * 목록에 있는 기고자 * 목록에 있는 구성원 * 목록에 있는 서비스 조직 데이터 유형: 문자열 | | item.type.sys_id | 관련 당사자 기록과 연결된 유형 기록의 Sys_id입니다. 데이터 유형: 문자열 | | item.user | 관련 당사자 기록과 연결된 사용자에 대한 상세 정보입니다. 데이터 유형: 객체 "user": { "display_value": "String", "sys_id": "String" } | | item.user.display_value | 관련 당사자 기록과 연결된 사용자의 텍스트 이름입니다. 이 값을 사용하여 UI에 사용자 이름을 표시합니다. 데이터 유형: 문자열 | | item.user.sys_id | 관련 당사자 기록과 연결된 사용자 기록의 Sys_id입니다. 사용자 \[sys_user\] 테이블에 있습니다. 데이터 유형: 문자열 | | 상태 | 엔드포인트 호출의 상태입니다. 데이터 유형: 문자열 | | sysparm_limit | 반환된 기록 수입니다. 이 값이 원래 요청에 지정되지 않은 경우 기본값이 사용됩니다. 데이터 유형: 숫자 | | sysparm_offset | 기록이 평가 및 검색된 관련 테이블의 오프셋(시작 지점)입니다. 데이터 유형: 문자열 | [ ] {#integrat-PATCH-relatedparties__id_gls_y2f_zwb} ### cURL 요청 다음 코드 예제에서는 이 엔드포인트를 호출하여 관련 당사자와 연결된 연락처 레코드를 업데이트하는 방법을 보여 줍니다. curl "https://instance.servicenow.com/api/sn_install_base/integrations/relatedparties/f77c7542b7343300ece839a6ee11a991" \ --request PATCH \ --header "Accept:application/json" \ --header "Content-Type:application/json" \ --data "{ \"contact\": \"dc0185d94f341200025ba3618110c77c\" }" \ --user 'username':'password' 반환 결과: { "result": { "type": { "display_value":"Authorized Contact", "sys_id":"68ec8b2965e99110f87764df53db779f" }, "install_base_item": { "display_value":"KX Series - KX5000", "sys_id":"f77c7542b7343300ece839a6ee11a991" }, "sys_class_name":"sn_install_base_related_party", "sys_id":"4659539814ac6910f877ae314c1fb43a", "responsibility": { "display_value":"Authorized Representative", "sys_id":"c009bbedb3730010700b4d43c6a8dcef" }, "contact": { "display_value":"Cindy Contact", "sys_id":"dc0185d94f341200025ba3618110c77c" }, "account": { "display_value":"Boxeo", "value":"86837a386f0331003b3c498f5d3ee4ca" }, "status":"SUCCESS", } } ## 설치 기반 항목 - PATCH /sn_install_base/integrations/installbaseitems/{id}/uninstall {#ariaid-title15} 지정된 설치 기반 항목을 제거합니다. 제거는 필드를 false로 설정하고 active 필드를 지정된 날짜로 설정하는 unistall_date 것으로 구성됩니다. 날짜 값이 제공되지 않은 경우 비어 있습니다. ### URL 형식 버전이 지정된 URL: /api/sn_install_base/{api_version}/integrations/installbaseitems/{id}/uninstall 기본 URL: /api/sn_install_base/integrations/installbaseitems/{id}/uninstall ### 지원되는 요청 매개변수 {#integrat-PATCH-uninstall__entry__2}{#integrat-PATCH-uninstall__version-RESTAPI}{#integrat-PATCH-uninstall__integrate-id-entry} | 이름 | 설명 | |-|-| | api_version | 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열 | | id | 설치 기반 항목 기록의 Sys_id입니다. 설치 기반 항목 \[sn_install_base_item\] 테이블에 있습니다. 데이터 유형: 문자열 | [표 79. 경로 매개변수] {#integrat-PATCH-uninstall__entry__8} | 이름 | 설명 | |-|-| | 없음 | | [표 80. 쿼리 매개변수] {#integrat-PATCH-uninstall__entry__12} | 이름 | 설명 | |-|-| | uninstall_date | 지정된 설치 기반 항목을 제거할 날짜입니다. 지정하지 않으면 즉시 제거됩니다. 데이터 유형: 문자열 형식: yyyy-mm-dd hh:mm:ss | [표 81. 요청 본문 매개변수(XML 또는 JSON)] ### 헤더 다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 [지원되는 REST API 헤더를](https://servicenow-prod.fluidtopics.net/JHL64oGR2SkU25ZTkfHy7g "REST(REpresentational State Transfer)는 웹상의 컴퓨터 시스템 간에 표준을 제공하여 서로 보다 쉽게 통신할 수 있게 지원하는 단순한 상태 비저장 아키텍처입니다.") 참조하세요. {#integrat-PATCH-uninstall__entry__16}{#integrat-PATCH-uninstall__accept-RESTAPI}{#integrat-PATCH-uninstall__content_type-RESTAPI} | 헤더 | 설명 | |-|-| | 수용 | 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json | | 컨텐츠-형식 | 요청 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json | [표 82. 요청 헤더] {#integrat-PATCH-uninstall__entry__22} | 헤더 | 설명 | |-|-| | 없음 | | [표 83. 응답 헤더] ### 상태 코드 다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 [REST API HTTP 응답 코드를](https://servicenow-prod.fluidtopics.net/JHL64oGR2SkU25ZTkfHy7g "REST(REpresentational State Transfer)는 웹상의 컴퓨터 시스템 간에 표준을 제공하여 서로 보다 쉽게 통신할 수 있게 지원하는 단순한 상태 비저장 아키텍처입니다.") 참조하세요. {#integrat-PATCH-uninstall__entry__26}{#integrat-PATCH-uninstall__entry-200-status-code}{#integrat-PATCH-uninstall__entry-400-status-code}{#integrat-PATCH-uninstall__entry-403-status-code}{#integrat-PATCH-uninstall__entry-404-status-code}{#integrat-PATCH-uninstall__entry-500-status-code} | 상태 코드 | 설명 | |-|-| | 200 | 성공입니다. 요청이 성공적으로 처리되었습니다. | | 400 | 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다. | | 403 | 금지되었습니다. 사용자에게 지정된 기록에 대한 액세스 권한이 없습니다. | | 404 | 찾을 수 없습니다. 요청한 항목을 찾을 수 없습니다. | | 500 | 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다. | [표 84. 상태 코드] ### 응답 본문 매개변수(JSON 또는 XML) {#integrat-PATCH-uninstall__entry__38}{#integrat-PATCH-uninstall__error-integration-entry}{#integrat-PATCH-uninstall__error_detail-integration-entry}{#integrat-PATCH-uninstall__error_message-integration-entry}{#integrat-PATCH-uninstall__account-integration-row}{#integrat-PATCH-uninstall__account_display_value-integration-row}{#integrat-PATCH-uninstall__account_sys_id-integration-row}{#integrat-PATCH-uninstall__active-integration-row}{#integrat-PATCH-uninstall__name-integration-row}{#integrat-PATCH-uninstall__number-integration-row}{#integrat-PATCH-uninstall__sys_class_name-integration-row}{#integrat-PATCH-uninstall__sys_id-integration-row}{#integrat-PATCH-uninstall__state-integration-row}{#integrat-PATCH-uninstall__state_display_value-integration-row}{#integrat-PATCH-uninstall__state_value-integration-row}{#integrat-PATCH-uninstall__status-integration-entry} | 이름 | 설명 | |-|-| | 오류 | 요청을 처리하려고 할 때 발생한 오류에 대한 상세 정보입니다. 데이터 유형: 객체 "error": { "detail": "String", "message": "String" } | | 오류.상세 정보 | 관련 오류에 대한 추가 정보입니다. 데이터 유형: 문자열 | | 오류.메시지 | 요청을 실행하려고 할 때 발생한 문제를 설명하는 오류 메시지입니다. 데이터 유형: 문자열 | | 항목 | 제거된 항목에 대한 설명입니다. 데이터 유형: 객체 "item": { "account": {Object}, "active": "String", "asset": {Object}, "configuration_item": {Object}, "consumer": {Object}, "consumer_profile": {Object}, "contact": {Object}, "health_status": {Object}, "health_status_last_updated": "String", "household": {Object}, "install_date": {Object}, "location": {Object}, "name": "String", "number": "String", "parent": {Object}, "product": {Object}, "service_context": {Object}, "service_organization" {Object}, "sys_class_name": "String", "sys_id": "String", "state": {Object}, "status": {Object}, "uninstall_date": "String" } | | item.account | 설치 기반 항목 기록과 연결된 고객 계정에 대한 세부 정보입니다. 데이터 유형: 객체 "account": { "display_value": "String", "sys_id": "String" } | | item.account.display_value | 설치 기반 항목 기록과 연결된 고객 계정의 텍스트 이름입니다. 이 값을 사용하여 UI에 고객 계정 이름을 표시합니다. 데이터 유형: 문자열 | | item.account.sys_id | 설치 기반 항목 기록과 연결된 고객 계정 기록의 Sys_id입니다. 데이터 유형: 문자열 | | item.active | 설치 기반 항목이 활성 상태인지 여부를 나타내는 플래그입니다. 가능한 값: * true: 설치 기반 항목이 활성 상태입니다. * false: 설치 기반 항목이 비활성 상태입니다. 데이터 유형: 부울 문자열 | | item.asset | 설치 기반 항목 기록과 연결된 자산에 대한 세부 정보입니다. 데이터 유형: 객체 "asset": { "display_value": "String", "sys_id": "String" } | | item.asset.display_value | 설치 기반 항목 기록과 연결된 자산의 텍스트 이름입니다. 이 값을 사용하여 UI에 자산 이름을 표시합니다. 데이터 유형: 문자열 | | item.asset.sys_id | 설치 기반 항목 기록과 연결된 자산 기록의 Sys_id입니다. 데이터 유형: 문자열 | | item.child_install_base_items | 이 설치 기반 항목과 연결된 하위 설치 기반 항목의 목록입니다. 주: 다음 하위 설치 기반 항목 필드는 상위 항목과 다를 수 없습니다. * 계정 * 소비자 * 연락처 * 서비스 조직 {#integrat-PATCH-uninstall__ul_fkz_s33_wxb} 데이터 형식: 객체 배열 "child_install_base_items": [ { "name": "String", "product": "String" } ] | | item.child_install_base_items.name | 하위 설치 기반 항목의 이름입니다. 데이터 유형: 문자열 | | item.child_install_base_items.제품 | 연결된 하위 기본 항목 기록의 Sys_id입니다. 설치 기반 항목 \[sn_install_base_item\] 테이블에 있습니다. 데이터 유형: 문자열 | | item.configuration_item | 설치 기반 항목 기록과 연결된 구성 항목에 대한 세부 정보입니다. 데이터 유형: 객체 "configuration_item": { "display_value": "String", "sys_id": "String" } | | item.configuration_display_value | 설치 기반 항목 기록과 연결된 구성 항목의 텍스트 이름입니다. 이 값을 사용하여 UI에 구성 항목 이름을 표시합니다. 데이터 유형: 문자열 | | item.configuration_sys_id | 설치 기반 항목 기록과 연결된 구성 항목 기록의 Sys_id입니다. 데이터 유형: 문자열 | | item.consumer | 설치 기반 항목 기록과 연결된 소비자에 대한 세부 정보입니다. 주: 소비자 필드는 B2B2C 플러그인이 설치된 경우에만 사용할 수 있습니다. 데이터 유형: 객체 "consumer": { "display_value": "String", "sys_id": "String" } | | item.consumer.display_value | 설치 기반 항목 기록과 연결된 소비자의 텍스트 이름입니다. 이 값을 사용하여 UI에 소비자 이름을 표시합니다. 데이터 유형: 문자열 | | item.consumer.sys_id | 설치 기반 항목 기록과 연결된 소비자 기록의 Sys_id입니다. 데이터 유형: 문자열 | | item.consumer_profile | 설치 기반 항목 기록과 연결된 소비자 프로필에 대한 세부 정보입니다. 주: 소비자 프로필 필드는 B2B2C 플러그인이 설치된 경우에만 사용할 수 있습니다. 데이터 유형: 객체 "consumer_profile": { "display_value": "String", "sys_id": "String" } | | item.consumer_profile.display_value | 설치 기반 항목 기록과 연결된 소비자 프로필의 텍스트 이름입니다. 이 값을 사용하여 UI에 소비자 프로파일 이름을 표시합니다. 데이터 유형: 문자열 | | item.consumer_profile.sys_id | 설치 기반 항목 기록과 연결된 소비자 프로필 기록의 Sys_id입니다. 데이터 유형: 문자열 | | item.contact | 설치 기반 항목 기록을 담당하는 계정 접촉 창구에 대한 세부 정보입니다. 데이터 유형: 객체 "contact": { "display_value": "String", "sys_id": "String" } | | item.contact.display_value | 설치 기반 항목 기록과 연결된 계정 연락처의 텍스트 이름입니다. 이 값을 사용하여 UI에 계정 접촉 창구 이름을 표시합니다. 데이터 유형: 문자열 | | item.contact.sys_id | 설치 기반 항목 기록과 연결된 계정 연락처 기록의 Sys_id입니다. 데이터 유형: 문자열 | | item.health_status | 설치 기반 항목의 현재 상태에 대한 세부 정보입니다. com.snc.proactive_cs_itom(사전 예방적 고객 서비스 운영) 플러그인이 설치된 경우에만 반환됩니다. 데이터 유형: 객체 "health_status": { "display_value": "String", "value": "String" } | | item.health_status.display_value | 설치 기반 항목의 현재 상태를 나타내는 텍스트 문자열입니다. 이 값을 사용하여 UI에 상태를 표시합니다. 데이터 유형: 문자열 | | item.health_status.value | 설치 기반 항목의 상태에 대한 내부 값입니다. 데이터 유형: 문자열 | | item.health_status_last_updated | 설치 기반 항목의 상태가 마지막으로 업데이트된 날짜 및 시간입니다. 데이터 유형: 문자열 | | item.household | 설치 기반 항목 기록과 연결된 세대에 대한 세부 정보입니다. Customer Service Household(com.snc.household) 플러그인이 설치된 경우에만 반환됩니다. 데이터 유형: 객체 "household": { "display_value": "String", "sys_id": "String" } | | item.household.display_value | 설치 기반 항목 기록과 연결된 세대의 텍스트 이름입니다. 이 값을 사용하여 UI에 세대 이름을 표시합니다. 데이터 유형: 문자열 | | item.household.sys_id | 설치 기반 항목 기록과 연결된 세대 Sys_id입니다. 데이터 유형: 문자열 | | item.install_date | 설치 기반 항목이 활성화된 날짜에 대한 세부 정보입니다. 데이터 유형: 객체 "install_date": { "display_value": "String", "value": "String" } | | item.install_date.display_value | 텍스트 설치 날짜입니다. 이 값을 사용하여 UI에 설치 날짜를 표시합니다. 데이터 유형: 문자열 | | item.install_date.값 | 설치 날짜의 내부 값입니다. 데이터 유형: 문자열 | | item.location | 설치 기반 항목의 위치에 대한 세부 정보입니다. 데이터 유형: 객체 "location": { "display_value": "String", "sys_id": "String" } | | item.location.display_value | 설치 기반 항목 위치의 텍스트 이름입니다. 이 값을 사용하여 UI에 위치 이름을 표시합니다. 데이터 유형: 문자열 | | item.location.sys_id | 설치 기반 항목 기록과 연결된 위치 기록의 Sys_id입니다. 데이터 유형: 문자열 | | item.name | 설치 기반 항목의 이름입니다. 데이터 유형: 문자열 | | item.number | 설치 기반 항목의 고유 ID입니다. 데이터 유형: 문자열 | | item.parent | 설치 기반 항목 기록의 상위 기록에 대한 세부 정보입니다. 데이터 유형: 객체 "parent": { "display_value": "String", "sys_id": "String" } | | item.parent.display_value | 설치 기반 항목 기록과 연결된 상위 기록의 텍스트 이름입니다. 이 값을 사용하여 UI에 상위 이름을 표시합니다. 데이터 유형: 문자열 | | item.parent.sys_id | 설치 기반 항목 기록과 연결된 상위 기록의 Sys_id입니다. 데이터 유형: 문자열 | | item.product | 설치 기반 항목 기록과 연결된 제품 모델에 대한 세부 정보입니다. 이 정보를 사용하여 제품 모델과 연결된 서비스를 식별합니다. 데이터 유형: 객체 "product": { "display_value": "String", "sys_id": "String" } | | item.product.display_value | 설치 기반 항목 기록과 연결된 제품 모델의 텍스트 이름입니다. 이 값을 사용하여 UI에 제품 이름을 표시합니다. 데이터 유형: 문자열 | | item.product.sys_id | 설치 기반 항목 기록과 연결된 제품 모델 기록의 Sys_id입니다. 데이터 유형: 문자열 | | item.quantity | 설치된 항목 수입니다. 데이터 형식: 정수 | | item.service_context | 설치 기반 항목 기록과 연결된 서비스 컨텍스트에 대한 상세 정보입니다. 데이터 유형: 객체 "service_context": { "display_value": "String", "sys_id": "String" } | | item.service_context.display_value | 설치 기반 항목 기록과 연결된 서비스 컨텍스트에 대한 상세 정보입니다. 데이터 유형: 객체 "service_context": { "display_value": "String", "sys_id": "String" } | | item.service_context.sys_id | 설치 기반 항목 기록과 연결된 서비스 컨텍스트 기록의 Sys_id입니다. 데이터 유형: 문자열 | | item.service_organization | 설치 기반 항목 기록과 연결된 서비스 조직에 대한 세부 정보입니다. Service Organization(com.snc.service_organization) 플러그인이 설치된 경우에만 반환됩니다. 데이터 유형: 객체 "service_organization": { "display_value": "String", "sys_id": "String" } | | item.service_organization.display_value | 설치 기반 항목 기록과 연결된 서비스 조직의 텍스트 이름입니다. 이 값을 사용하여 UI에 서비스 조직 이름을 표시합니다. 데이터 유형: 문자열 | | item.service_organization.sys_id | 설치 기반 항목 기록과 연결된 서비스 조직 기록의 Sys_id입니다. 데이터 유형: 문자열 | | item.sys_클래스_이름 | 설치 기반 항목 기록을 포함하는 테이블입니다. 데이터 유형: 문자열 | | item.sys_id | 설치 기반 항목 기록의 Sys_id입니다. 매개변수에 지정된 sys_class_name 테이블에 있습니다. 데이터 유형: 문자열 | | item.state | 설치 기반 항목의 현재 상태에 대한 세부 정보입니다. 데이터 유형: 객체 "state": { "display_value": "String", "value": "String" } | | item.state.display_value | 설치 기반 항목의 현재 상태에 대한 텍스트 문자열입니다. 이 값을 사용하여 UI에 상태를 표시합니다. 데이터 유형: 문자열 | | item.state.value | 설치 기반 항목의 상태에 대한 내부 값입니다. 데이터 유형: 문자열 | | item.status | 설치 기반 항목의 상태에 대한 세부 정보입니다. 데이터 유형: 객체 "status": { "display_value": "String", "value": "String" } | | item.status.display_value | 설치 기반 항목의 상태에 대한 텍스트 문자열입니다. 이 값을 사용하여 UI에 상태를 표시합니다. 데이터 유형: 문자열 | | item.status.value | 설치 기반 항목의 상태에 대한 내부 값입니다. 데이터 유형: 문자열 | | item.uninstall_date | 설치 기반 항목이 비활성 상태가 된 날짜에 대한 세부 정보입니다. 데이터 유형: 객체 "uninstall_date": { "display_value": "String", "value": "String" } | | item.uninstall_date.display_value | 텍스트 제거 날짜. 이 값을 사용하여 UI에 제거 날짜를 표시합니다. 데이터 유형: 문자열 | | item.uninstall_date.value | 제거 날짜의 내부 값입니다. 데이터 유형: 문자열 | | 상태 | 엔드포인트 호출의 상태입니다. 데이터 유형: 문자열 | [ ] ### cURL 요청 다음 코드 예제에서는 이 끝점을 호출하는 방법을 보여 줍니다. curl "https://instance.servicenow.com/api/sn_install_base/integrations/installbaseitems/42746a3b876121100b6afc86dabb3597/uninstall" \ --request PATCH \ --header "Accept:application/json" \ --user 'username':'password' 반환 결과: { "result": { "status": "SUCCESS", "item": { "sys_class_name": { "value": "sn_install_base_item", "display_value": "Install Base Item" }, "number": "IBITM0000901", "sys_id": "f77c7542b7343300ece839a6ee11a991", "contact": { "sys_id": "4d147a386f0331003b3c498f5d3ee437", "display_value": "Julie Lewis" }, "state": { "value": "inactive", "display_value": "Inactive" }, "active": "false", "configuration_item": { "sys_id": "e5a28e07c30202001efd5cb981d3aedb", "display_value": "KX Series - KX5000" }, "name": "KX Series - KX5000", "account": { "sys_id": "86837a386f0331003b3c498f5d3ee4ca", "display_value": "Boxeo" } } } } ## 설치 기반 항목 - POST /sn_install_base/integrations/installbaseitems {#ariaid-title16} 기본 설치 기반 항목 테이블 또는 확장된 테이블(지정된 경우)에 하나 이상의 설치 기반 항목 기록을 만들고 지정된 필드 값으로 채웁니다. 단일 설치 기반 항목 레코드를 만들 때 요청 본문에 포함할 모든 필드가 포함된 개체를 요청 본문에 전달합니다. 단일 호출에서 여러 설치 기반 항목 레코드를 만드는 경우 만들 모든 레코드가 포함된 요청 본문의 개체 배열을 전달합니다. 엔드포인트는 각 레코드 생성 개체를 개별적으로 처리하고 보고합니다. 하나 이상의 기록을 생성하지 못해도 다른 기록 생성에는 영향을 주지 않습니다. ### URL 형식 버전이 지정된 URL: /api/sn_install_base/{api_version}/integrations/installbaseitems 기본 URL: /api/sn_install_base/integrations/installbaseitems ### 지원되는 요청 매개변수 {#integrat-POST-installbaseitems__entry__2}{#integrat-POST-installbaseitems__version-RESTAPI} | 이름 | 설명 | |-|-| | api_version | 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열 | [표 85. 경로 매개변수] {#integrat-POST-installbaseitems__entry__6} | 이름 | 설명 | |-|-| | 없음 | | [표 86. 쿼리 매개변수] {#integrat-POST-installbaseitems__id_x5m_53g_xwb__entry__2}{#integrat-POST-installbaseitems__account-request-integration-entry}{#integrat-POST-installbaseitems__active-request-integration-entry}{#integrat-POST-installbaseitems__asset-request-integration-entry}{#integrat-POST-installbaseitems__child_install_base_items-request-integration-entry}{#integrat-POST-installbaseitems__child_install_base_items_name-request-integration-entry}{#integrat-POST-installbaseitems__child_install_base_items_product-request-integration-entry}{#integrat-POST-installbaseitems__configuration_item-request-integration-entry}{#integrat-POST-installbaseitems__consumer-request-integration-entry}{#integrat-POST-installbaseitems__consumer_profile-request-integration-entry}{#integrat-POST-installbaseitems__contact-request-integration-entry}{#integrat-POST-installbaseitems__household-request-integration-entry}{#integrat-POST-installbaseitems__install_date-request-integration-entry}{#integrat-POST-installbaseitems__location-request-integration-entry}{#integrat-POST-installbaseitems__name-request-integration-entry}{#integrat-POST-installbaseitems__number-request-integration-entry}{#integrat-POST-installbaseitems__parent-request-integration-entry}{#integrat-POST-installbaseitems__product-request-integration-entry}{#integrat-POST-installbaseitems__quantity-request-integration-entry}{#integrat-POST-installbaseitems__service_context-request-integration-entry}{#integrat-POST-installbaseitems__service_organization-request-integration-entry}{#integrat-POST-installbaseitems__state-request-integration-entry}{#integrat-POST-installbaseitems__status-request-integration-entry}{#integrat-POST-installbaseitems__uninstall_date-request-integration-entry} | 이름 | 설명 | |-|-| | 계정 | 계정에 대한 설치 기반 항목을 생성할 때 필요합니다. 설치 기반 항목과 연결할 계정의 Sys_id입니다. 계정 \[customer_account\] 테이블에 있습니다. 주: 매개 변수를 전달 account 하면 매개 변수도 consumer 전달할 수 없습니다. 데이터 유형: 문자열 | | active | 설치 기반 항목이 활성 상태인지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. * true, "true" 또는 "0": 항목이 활성 상태입니다. * false, "false" 또는 "1": 항목이 활성 상태가 아닙니다. 데이터 유형: 부울 기본값: true | | asset | 설치 기반 항목 기록과 연결된 자산의 Sys_id입니다. 자산 \[alm_asset\] 테이블에 있습니다. 데이터 유형: 문자열 | | child_install_base_items | 이 설치 기반 항목과 연결된 하위 설치 기반 항목의 목록입니다. 주: 다음 하위 설치 기반 항목 필드는 상위 항목과 다를 수 없습니다. * 계정 * 소비자 * 연락처 * 서비스 조직 {#integrat-POST-installbaseitems__ul_fkz_s33_wxb} 데이터 형식: 객체 배열 "child_install_base_items": [ { "name": "String", "product": "String" } ] | | child_install_base_items.이름 | 하위 설치 기반 항목의 이름입니다. 데이터 유형: 문자열 | | child_install_base_items.제품 | 연결된 하위 기본 항목 기록의 Sys_id입니다. 설치 기반 항목 \[sn_install_base_item\] 테이블에 있습니다. 데이터 유형: 문자열 | | configuration_item | 설치 기반 항목 기록과 연결된 구성 항목의 Sys_id입니다. 구성 항목 \[cmdb_ci\] 테이블에 있습니다. 데이터 유형: 문자열 | | 소비자 | 소비자에 대한 설치 기반 항목을 만들 때 필요합니다. 설치 기반 항목 기록과 연결된 소비자의 Sys_id입니다. 소비자 \[csm_consumer\] 테이블에 있습니다. 주: 매개 변수를 전달 consumer 하면 매개 변수도 account 전달할 수 없습니다. 또한 B2B2C 플러그인이 인스턴스에 설치된 경우에만 소비자를 설치 기반 항목과 연결할 수 있습니다. 데이터 유형: 문자열 | | consumer_profile | 설치 기반 항목 기록과 연결된 소비자 프로필의 Sys_id입니다. 소비자 프로필 \[sn_csm_consumer_profile\] 테이블에 있습니다. 데이터 유형: 문자열 | | 연락처 | 설치 기반 항목을 1차적으로 담당하는 계정 접촉 창구 기록의 Sys_id입니다. 연락처 \[customer_contact\] 테이블에 있습니다. 주: 계정 설치 기반 항목에 대해서만 연락처를 지정할 수 있습니다. 데이터 유형: 문자열 | | household | 설치 기반 항목 기록과 연결된 세대 Sys_id입니다. 세대\[csm_household\] 테이블에 있습니다. 주: 이 필드는 Customer Service Household(com.snc.household) 플러그인이 설치된 경우에만 유효합니다. 데이터 유형: 문자열 | | install_date | 설치 기반 항목이 활성 상태가 된 날짜입니다. 데이터 유형: 문자열 형식: yyyy-MM-dd HH:mm:ss | | 위치 | 연결된 제품 위치의 Sys_id입니다. 위치 \[cmn_location\] 테이블에 있습니다. 데이터 유형: 문자열 | | 이름 | 설치 기반 항목의 이름입니다. 데이터 유형: 문자열 | | 번호 | 설치 기반 항목의 고유 식별자입니다. 데이터 유형: 문자열 기본값: 엔드포인트에서 자동으로 생성됩니다. | | 상위 | 이 설치 기반 항목 기록의 상위 기록 Sys_id입니다. 설치 기반 항목 \[sn_install_base_item\] 테이블에 있습니다. 데이터 유형: 문자열 | | product_model | 설치 기반 항목 기록과 연결된 제품 모델의 Sys_id입니다. 제품 모델 \[cmdb_model\] 테이블에 있습니다. 데이터 유형: 문자열 | | 수량 | 설치된 항목 수입니다. 데이터 형식: 정수 | | service_context | 이벤트 관리에서 영향 심각도를 계산하기 위해 기본 CI와 연결된 서비스 Sys_id입니다. 자세한 내용은 [Service health status for install base](https://www.servicenow.com/docs/access?context=service-health-pcso&version=xanadu&pubname=xanadu-customer-service-management&ft:locale=en-US) 문서를 참조하십시오. 주: 이 필드는 이벤트 관리를 포함한 사전 예방적 고객 서비스 운영 플러그인이 설치된 경우에만 유효합니다. 데이터 유형: 문자열 | | service_organization | 서비스 조직에 대한 설치 기반 항목을 생성할 때 필요합니다. 고객에게 서비스를 제공하는 데 관여하는 서비스 조직 기록의 Sys_id입니다. 서비스 조직 \[sn_customer_service_organization\] 테이블에 있습니다. 주: 이 매개 변수를 전달하는 경우 계정, 연락처 또는 소비자 매개 변수도 전달해서는 안 됩니다. 이 service_organization 매개변수는 인스턴스에 Service Organization(com.snc.service_organization) 플러그인이 설치된 경우에만 사용할 수 있습니다. 데이터 유형: 문자열 | | 상태 | 설치 기반 항목의 현재 상태입니다. 유효한 값은 다음과 같습니다. * in_use * 비활성 데이터 유형: 문자열 | | 상태 | 제품의 상태입니다. 유효한 값은 다음과 같습니다. * 원본 * 교체 데이터 유형: 문자열 | | sys_class_name | 설치 기반 항목 기록을 생성할 확장 설치 기반 테이블의 이름입니다. 데이터 유형: 문자열 기본값: 설치 기반 항목 \[sn_install_base_item\] 테이블 | | uninstall_date | 설치 기반이 비활성 상태가 된 날짜입니다. 데이터 유형: 문자열 형식: yyyy-MM-dd HH:mm:ss | [표 87. 요청 본문 매개변수(XML 또는 JSON)] {#integrat-POST-installbaseitems__id_x5m_53g_xwb} ### 헤더 다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 [지원되는 REST API 헤더를](https://servicenow-prod.fluidtopics.net/JHL64oGR2SkU25ZTkfHy7g "REST(REpresentational State Transfer)는 웹상의 컴퓨터 시스템 간에 표준을 제공하여 서로 보다 쉽게 통신할 수 있게 지원하는 단순한 상태 비저장 아키텍처입니다.") 참조하세요. {#integrat-POST-installbaseitems__entry__60}{#integrat-POST-installbaseitems__accept-RESTAPI}{#integrat-POST-installbaseitems__content_type-RESTAPI} | 헤더 | 설명 | |-|-| | 수용 | 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json | | 컨텐츠-형식 | 요청 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json | [표 88. 요청 헤더] {#integrat-POST-installbaseitems__entry__66} | 헤더 | 설명 | |-|-| | 없음 | | [표 89. 응답 헤더] ### 상태 코드 다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 [REST API HTTP 응답 코드를](https://servicenow-prod.fluidtopics.net/JHL64oGR2SkU25ZTkfHy7g "REST(REpresentational State Transfer)는 웹상의 컴퓨터 시스템 간에 표준을 제공하여 서로 보다 쉽게 통신할 수 있게 지원하는 단순한 상태 비저장 아키텍처입니다.") 참조하세요. {#integrat-POST-installbaseitems__entry__70}{#integrat-POST-installbaseitems__entry-200-status-code}{#integrat-POST-installbaseitems__entry-400-status-code}{#integrat-POST-installbaseitems__entry-403-status-code}{#integrat-POST-installbaseitems__entry-500-status-code} | 상태 코드 | 설명 | |-|-| | 200 | 성공입니다. 요청이 성공적으로 처리되었습니다. | | 400 | 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다. | | 403 | 금지되었습니다. 사용자에게 지정된 기록에 대한 액세스 권한이 없습니다. | | 500 | 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다. | [표 90. 상태 코드] ### 응답 본문 매개변수(JSON 또는 XML) {#integrat-POST-installbaseitems__id_fw5_m3f_xwb__entry__2}{#integrat-POST-installbaseitems__error-integration-entry}{#integrat-POST-installbaseitems__error_detail-integration-entry}{#integrat-POST-installbaseitems__error_message-integration-entry}{#integrat-POST-installbaseitems__account-integration-row}{#integrat-POST-installbaseitems__account_display_value-integration-row}{#integrat-POST-installbaseitems__account_sys_id-integration-row}{#integrat-POST-installbaseitems__active-integration-row}{#integrat-POST-installbaseitems__name-integration-row}{#integrat-POST-installbaseitems__number-integration-row}{#integrat-POST-installbaseitems__sys_class_name-integration-row}{#integrat-POST-installbaseitems__sys_id-integration-row}{#integrat-POST-installbaseitems__state-integration-row}{#integrat-POST-installbaseitems__state_display_value-integration-row}{#integrat-POST-installbaseitems__state_value-integration-row}{#integrat-POST-installbaseitems__status-integration-row} | 이름 | 설명 | |-|-| | 오류 | 요청을 처리하려고 할 때 발생한 오류에 대한 상세 정보입니다. 데이터 유형: 객체 "error": { "detail": "String", "message": "String" } | | 오류.상세 정보 | 관련 오류에 대한 추가 정보입니다. 데이터 유형: 문자열 | | 오류.메시지 | 요청을 실행하려고 할 때 발생한 문제를 설명하는 오류 메시지입니다. 데이터 유형: 문자열 | | 항목 | 지정된 필터 결과와 일치하는 설치 기반 항목입니다. 비어 있지 않은 필드만 반환됩니다. 데이터 형식: 객체 배열 "item": { "account": {Object}, "active": "String", "asset": {Object}, "child_install_base_items": {Object}, "condition": "String", "configuration_item": {Object}, "consumer": {Object}, "consumer_profile": {Object}, "contact": {Object}, "health_status": {Object}, "health_status_last_updated": "String", "household": {Object}, "install_date": {Object}, "location": {Object}, "name": "String", "number": "String", "parent": {Object}, "product": {Object}, "quantity": Integer, "service_context": {Object}, "service_organization" {Object}, "sys_id": "String", "state": {Object}, "status": {Object}, "uninstall_date": "String" } | | item.account | 설치 기반 항목 기록과 연결된 고객 계정에 대한 세부 정보입니다. 데이터 유형: 객체 "account": { "display_value": "String", "sys_id": "String" } | | item.account.display_value | 설치 기반 항목 기록과 연결된 고객 계정의 텍스트 이름입니다. 이 값을 사용하여 UI에 고객 계정 이름을 표시합니다. 데이터 유형: 문자열 | | item.account.sys_id | 설치 기반 항목 기록과 연결된 고객 계정 기록의 Sys_id입니다. 데이터 유형: 문자열 | | item.active | 설치 기반 항목이 활성 상태인지 여부를 나타내는 플래그입니다. 가능한 값: * true: 설치 기반 항목이 활성 상태입니다. * false: 설치 기반 항목이 비활성 상태입니다. 데이터 유형: 부울 문자열 | | item.asset | 설치 기반 항목 기록과 연결된 자산에 대한 세부 정보입니다. 데이터 유형: 객체 "asset": { "display_value": "String", "sys_id": "String" } | | item.asset.display_value | 설치 기반 항목 기록과 연결된 자산의 텍스트 이름입니다. 이 값을 사용하여 UI에 자산 이름을 표시합니다. 데이터 유형: 문자열 | | item.asset.sys_id | 설치 기반 항목 기록과 연결된 자산 기록의 Sys_id입니다. 데이터 유형: 문자열 | | item.child_install_base_items | 이 설치 기반 항목과 연결된 하위 설치 기반 항목의 목록입니다. 주: 다음 하위 설치 기반 항목 필드는 상위 항목과 다를 수 없습니다. * 계정 * 소비자 * 연락처 * 서비스 조직 {#integrat-POST-installbaseitems__d2842e1029} 데이터 형식: 객체 배열 "child_install_base_items": [ { "name": "String", "product": "String" } ] | | item.child_install_base_items.name | 하위 설치 기반 항목의 이름입니다. 데이터 유형: 문자열 | | item.child_install_base_items.제품 | 연결된 하위 기본 항목 기록의 Sys_id입니다. 설치 기반 항목 \[sn_install_base_item\] 테이블에 있습니다. 데이터 유형: 문자열 | | item.configuration_item | 설치 기반 항목 기록과 연결된 구성 항목에 대한 세부 정보입니다. 데이터 유형: 객체 "configuration_item": { "display_value": "String", "sys_id": "String" } | | item.configuration_item.display_value | 설치 기반 항목 기록과 연결된 구성 항목의 텍스트 이름입니다. 이 값을 사용하여 UI에 구성 항목 이름을 표시합니다. 데이터 유형: 문자열 | | item.configuration_item.sys_id | 설치 기반 항목 기록과 연결된 구성 항목 기록의 Sys_id입니다. 데이터 유형: 문자열 | | item.consumer | 설치 기반 항목 기록과 연결된 소비자에 대한 세부 정보입니다. 주: 소비자 필드는 B2B2C 플러그인이 설치된 경우에만 사용할 수 있습니다. 데이터 유형: 객체 "consumer": { "display_value": "String", "sys_id": "String" } | | item.consumer.display_value | 설치 기반 항목 기록과 연결된 소비자의 텍스트 이름입니다. 이 값을 사용하여 UI에 소비자 이름을 표시합니다. 데이터 유형: 문자열 | | item.consumer.sys_id | 설치 기반 항목 기록과 연결된 소비자 기록의 Sys_id입니다. 데이터 유형: 문자열 | | item.consumer_profile | 설치 기반 항목 기록과 연결된 소비자 프로필에 대한 세부 정보입니다. 주: 소비자 프로필 필드는 B2B2C 플러그인이 설치된 경우에만 사용할 수 있습니다. 데이터 유형: 객체 "consumer_profile": { "display_value": "String", "sys_id": "String" } | | item.consumer_profile.display_value | 설치 기반 항목 기록과 연결된 소비자 프로필의 텍스트 이름입니다. 이 값을 사용하여 UI에 소비자 프로파일 이름을 표시합니다. 데이터 유형: 문자열 | | item.consumer_profile.sys_id | 설치 기반 항목 기록과 연결된 소비자 프로필 기록의 Sys_id입니다. 데이터 유형: 문자열 | | item.contact | 설치 기반 항목 기록을 담당하는 계정 접촉 창구에 대한 세부 정보입니다. 데이터 유형: 객체 "contact": { "display_value": "String", "sys_id": "String" } | | item.contact.display_value | 설치 기반 항목 기록과 연결된 계정 연락처의 텍스트 이름입니다. 이 값을 사용하여 UI에 계정 접촉 창구 이름을 표시합니다. 데이터 유형: 문자열 | | item.contact.sys_id | 설치 기반 항목 기록과 연결된 계정 연락처 기록의 Sys_id입니다. 데이터 유형: 문자열 | | item.health_status | 설치 기반 항목의 현재 상태에 대한 세부 정보입니다. com.snc.proactive_cs_itom(사전 예방적 고객 서비스 운영) 플러그인이 설치된 경우에만 반환됩니다. 데이터 유형: 객체 "health_status": { "display_value": "String", "value": "String" } | | item.health_status.display_value | 설치 기반 항목의 현재 상태를 나타내는 텍스트 문자열입니다. 이 값을 사용하여 UI에 상태를 표시합니다. 데이터 유형: 문자열 | | item.health_status.value | 설치 기반 항목의 상태에 대한 내부 값입니다. 데이터 유형: 문자열 | | item.health_status_last_updated | 설치 기반 항목의 상태가 마지막으로 업데이트된 날짜 및 시간입니다. 데이터 유형: 문자열 | | item.household | 설치 기반 항목 기록과 연결된 세대에 대한 세부 정보입니다. Customer Service Household(com.snc.household) 플러그인이 설치된 경우에만 반환됩니다. 데이터 유형: 객체 "household": { "display_value": "String", "sys_id": "String" } | | item.household.display_value | 설치 기반 항목 기록과 연결된 세대의 텍스트 이름입니다. 이 값을 사용하여 UI에 세대 이름을 표시합니다. 데이터 유형: 문자열 | | item.household.sys_id | 설치 기반 항목 기록과 연결된 세대 Sys_id입니다. 데이터 유형: 문자열 | | item.install_date | 설치 기반 항목이 활성화된 날짜에 대한 세부 정보입니다. 데이터 유형: 객체 "install_date": { "display_value": "String", "value": "String" } | | item.install_date.display_value | 텍스트 설치 날짜입니다. 이 값을 사용하여 UI에 설치 날짜를 표시합니다. 데이터 유형: 문자열 | | item.install_date.값 | 설치 날짜의 내부 값입니다. 데이터 유형: 문자열 | | item.location | 설치 기반 항목의 위치에 대한 세부 정보입니다. 데이터 유형: 객체 "location": { "display_value": "String", "sys_id": "String" } | | item.location.display_value | 설치 기반 항목 위치의 텍스트 이름입니다. 이 값을 사용하여 UI에 위치 이름을 표시합니다. 데이터 유형: 문자열 | | item.location.sys_id | 설치 기반 항목 기록과 연결된 위치 기록의 Sys_id입니다. 데이터 유형: 문자열 | | item.name | 설치 기반 항목의 이름입니다. 데이터 유형: 문자열 | | item.number | 설치 기반 항목의 고유 ID입니다. 데이터 유형: 문자열 | | item.parent | 설치 기반 항목 기록의 상위 기록에 대한 세부 정보입니다. 데이터 유형: 객체 "parent": { "display_value": "String", "sys_id": "String" } | | item.parent.display_value | 설치 기반 항목 기록과 연결된 상위 기록의 텍스트 이름입니다. 이 값을 사용하여 UI에 상위 이름을 표시합니다. 데이터 유형: 문자열 | | item.parent.sys_id | 설치 기반 항목 기록과 연결된 상위 기록의 Sys_id입니다. 데이터 유형: 문자열 | | item.product | 설치 기반 항목 기록과 연결된 제품 모델에 대한 세부 정보입니다. 이 정보를 사용하여 제품 모델과 연결된 서비스를 식별합니다. 데이터 유형: 객체 "product": { "display_value": "String", "sys_id": "String" } | | item.product.display_value | 설치 기반 항목 기록과 연결된 제품 모델의 텍스트 이름입니다. 이 값을 사용하여 UI에 제품 이름을 표시합니다. 데이터 유형: 문자열 | | item.product.sys_id | 설치 기반 항목 기록과 연결된 제품 모델 기록의 Sys_id입니다. 데이터 유형: 문자열 | | item.quantity | 설치된 항목 수입니다. 데이터 형식: 정수 | | item.service_context | 설치 기반 항목 기록과 연결된 서비스 컨텍스트에 대한 상세 정보입니다. 데이터 유형: 객체 "service_context": { "display_value": "String", "sys_id": "String" } | | item.service_context.display_value | 설치 기반 항목 기록과 연결된 서비스 컨텍스트에 대한 상세 정보입니다. 데이터 유형: 객체 "service_context": { "display_value": "String", "sys_id": "String" } | | item.service_context.sys_id | 설치 기반 항목 기록과 연결된 서비스 컨텍스트 기록의 Sys_id입니다. 데이터 유형: 문자열 | | item.service_organization | 설치 기반 항목 기록과 연결된 서비스 조직에 대한 세부 정보입니다. Service Organization(com.snc.service_organization) 플러그인이 설치된 경우에만 반환됩니다. 데이터 유형: 객체 "service_organization": { "display_value": "String", "sys_id": "String" } | | item.service_organization.display_value | 설치 기반 항목 기록과 연결된 서비스 조직의 텍스트 이름입니다. 이 값을 사용하여 UI에 서비스 조직 이름을 표시합니다. 데이터 유형: 문자열 | | item.service_organization.sys_id | 설치 기반 항목 기록과 연결된 서비스 조직 기록의 Sys_id입니다. 데이터 유형: 문자열 | | item.sys_클래스_이름 | 설치 기반 항목 기록을 포함하는 테이블입니다. 데이터 유형: 문자열 | | item.sys_id | 설치 기반 항목 기록의 Sys_id입니다. 매개변수에 지정된 sys_class_name 테이블에 있습니다. 데이터 유형: 문자열 | | item.state | 설치 기반 항목의 현재 상태에 대한 세부 정보입니다. 데이터 유형: 객체 "state": { "display_value": "String", "value": "String" } | | item.state.display_value | 설치 기반 항목의 현재 상태에 대한 텍스트 문자열입니다. 이 값을 사용하여 UI에 상태를 표시합니다. 데이터 유형: 문자열 | | item.state.value | 설치 기반 항목의 상태에 대한 내부 값입니다. 데이터 유형: 문자열 | | item.status | 설치 기반 항목의 상태에 대한 세부 정보입니다. 데이터 유형: 객체 "status": { "display_value": "String", "value": "String" } | | item.status.display_value | 설치 기반 항목의 상태에 대한 텍스트 문자열입니다. 이 값을 사용하여 UI에 상태를 표시합니다. 데이터 유형: 문자열 | | item.status.value | 설치 기반 항목의 상태에 대한 내부 값입니다. 데이터 유형: 문자열 | | item.uninstall_date | 설치 기반 항목이 비활성 상태가 된 날짜에 대한 세부 정보입니다. 데이터 유형: 객체 "uninstall_date": { "display_value": "String", "value": "String" } | | item.uninstall_date.display_value | 텍스트 제거 날짜. 이 값을 사용하여 UI에 제거 날짜를 표시합니다. 데이터 유형: 문자열 | | item.uninstall_date.value | 제거 날짜의 내부 값입니다. 데이터 유형: 문자열 | | 상태 | 엔드포인트 호출의 상태입니다. 데이터 유형: 문자열 | [ ] {#integrat-POST-installbaseitems__id_fw5_m3f_xwb} ### cURL 요청 {#integrat-POST-installbaseitems__example_hb3_rsd_bxb} 다음 코드 예제에서는 단일 설치 기반 항목 레코드를 만드는 방법을 보여 줍니다. curl "https://instance.servicenow.com/api/sn_install_base/integrations/installbaseitems" \ --request POST \ --header "Accept:application/json" \ --header "Content-Type:application/json" \ --data "{ \"name\":\"Base Monitor\", \"quantity\": 4, \"account\":\"86837a386f0331003b3c498f5d3ee4ca\", \"contact\": \"dc0185d94f341200025ba3618110c77c\", \"configuration_item\":\"0c43baaac61122750182c132ee74bcf0\", \"state\":\"in_use\" }" \ --user 'username':'password' 결과 반환: 비어 있지 않은 필드만 반환됩니다. { "result": { "status": "SUCCESS", "item": { "sys_class_name": "sn_install_base_item", "number": "IBITM0001003", "sys_id": "27cb093114c66910f877324710112fd6", "contact": { "sys_id": "dc0185d94f341200025ba3618110c77c", "display_value": "Cindy Contact" }, "state": { "value": "in_use", "display_value": "In Use" }, "quantity": "4", "active": "true", "configuration_item": { "sys_id": "0c43baaac61122750182c132ee74bcf0", "display_value": "3D Pinball" }, "name": "Base Monitor", "account": { "sys_id": "86837a386f0331003b3c498f5d3ee4ca", "display_value": "Boxeo" } } } } ### cURL 요청 다음 코드 예제에서는 여러 설치 기반 항목 레코드를 만드는 방법을 보여 줍니다. curl "https://instance.servicenow.com/api/sn_install_base/integrations/installbaseitems" \ --request POST \ --header "Accept:application/json" \ --header "Content-Type:application/json" \ --data "[ { \"name\":\"AST4 Laptop\", \"consumer\":\"b119803fdb1b1200b6075200cf961917\", \"status\":\"replacement\", \"install_date\":\"2023-05-18 12:00:00\", \"uninstall_date\":\"2023-09-28 12:00:00\" }, { \"name\":\"Base Monitor\", \"quantity\": 4, \"account\":\"86837a386f0331003b3c498f5d3ee4ca\", \"contact\": \"dc0185d94f341200025ba3618110c77c\", \"configuration_item\":\"0c43baaac61122750182c132ee74bcf0\", \"state\":\"in_use\" } ]" \ --user 'username':'password' 결과 반환: 비어 있지 않은 필드만 반환됩니다. { "result": { "status": "SUCCESS", "items": [ { "status": "SUCCESS", "item": { "sys_class_name": "sn_install_base_item", "number": "IBITM0001018", "sys_id": "16fe91b1140a6910f877324710112f40", "uninstall_date": { "value": "2023-09-28 12:00:00", "display_value": "2023-09-28 05:00:00" }, "install_date": { "value": "2023-05-18 12:00:00", "display_value": "2023-05-18 05:00:00" }, "consumer": { "sys_id": "b119803fdb1b1200b6075200cf961917", "display_value": "Silvester Erik" }, "active": "true", "name": "AST4 Laptop", "status": { "value": "replacement", "display_value": "Replacement" } } }, { "status": "SUCCESS", "item": { "sys_class_name": "sn_install_base_item", "number": "IBITM0001019", "sys_id": "5efe91b1140a6910f877324710112f40", "contact": { "sys_id": "dc0185d94f341200025ba3618110c77c", "display_value": "Cindy Contact" }, "state": { "value": "in_use", "display_value": "In Use" }, "quantity": "4", "active": "true", "configuration_item": { "sys_id": "0c43baaac61122750182c132ee74bcf0", "display_value": "3D Pinball" }, "name": "Base Monitor", "account": { "sys_id": "86837a386f0331003b3c498f5d3ee4ca", "display_value": "Boxeo" } } } ] } } ## 설치 기반 항목 - POST /sn_install_base/integrations/installbaseitems/{id}/relatedparties {#ariaid-title17} 관련 당사자 기록을 생성하고 지정된 설치 기반 항목 기록과 연결합니다. 요청 매개변수에 지정된 값은 새로 생성된 관련 당사자 기록에 저장됩니다.
### URL 형식 버전이 지정된 URL: /api/sn_install_base/{api_version}/integrations/installbaseitems/{id}/relatedparties 기본 URL: /api/sn_install_base/integrations/installbaseitems/{id}/relatedparties ### 지원되는 요청 매개변수 {#integrat-POST-relatedparties__entry__2}{#integrat-POST-relatedparties__version-RESTAPI}{#integrat-POST-relatedparties__integrate-id-entry} | 이름 | 설명 | |-|-| | api_version | 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열 | | id | 설치 기반 항목 기록의 Sys_id입니다. 설치 기반 항목 \[sn_install_base_item\] 테이블에 있습니다. 데이터 유형: 문자열 | [표 91. 경로 매개변수] {#integrat-POST-relatedparties__entry__8} | 이름 | 설명 | |-|-| | 없음 | | [표 92. 쿼리 매개변수] {#integrat-POST-relatedparties__entry__12}{#integrat-POST-relatedparties__account-request-integration-entry}{#integrat-POST-relatedparties__consumer-request-integration-entry}{#integrat-POST-relatedparties__service_organization-request-integration-entry} | 이름 | 설명 | |-|-| | 계정 | 매개변수가 type 다음 중 하나인 경우 필수입니다. * 인증된 계정 * 인증된 접촉 창구 * 목록에 있는 계정 * 접촉 창구 목록 설치 기반 항목과 연결할 계정의 Sys_id입니다. 계정 \[customer_account\] 테이블에 있습니다. 주: 매개 변수를 전달 account 하면 매개 변수도 consumer 전달할 수 없습니다. 데이터 유형: 문자열 | | 소비자 | 매개변수가 type인증된 소비자 또는 나열된 소비자인 경우 필수입니다. 설치 기반 항목 기록과 연결된 소비자의 Sys_id입니다. 소비자 \[csm_consumer\] 테이블에 있습니다. 주: 매개 변수를 전달 consumer 하면 매개 변수도 account 전달할 수 없습니다. 또한 B2B2C 플러그인이 인스턴스에 설치된 경우에만 소비자를 설치 기반 항목과 연결할 수 있습니다. 데이터 유형: 문자열 | | 연락처 | 관련 당사자 기록과 연결된 연락처 기록의 Sys_id입니다. 연락처 \[customer_contact\] 테이블에 있습니다. 데이터 유형: 문자열 | | install_base_item | 관련 당사자 기록과 연결된 설치 기반 항목 기록의 Sys_id입니다. 데이터 유형: 문자열 | | 책임 | 연결된 책임 기록의 Sys_id입니다. 이 기록은 설치 기반 정보에 대한 액세스 수준을 정의합니다. 책임 정의 \[sn_customerservice_responsibility_def\] 테이블에 있습니다. 이 매개변수는 필드도 related_party 지정된 경우에만 유효합니다. 지정한 경우 및 responsibility 매개변수 모두 related_party 와 일치하는 설치 기반 항목만 반환합니다. 자세한 내용은 다음을 참조하십시오. [Configure related parties for items received](https://www.servicenow.com/docs/access?context=psds-add-related-parties-to-record&version=xanadu&pubname=xanadu-government-industry&ft:locale=en-US) 데이터 유형: 문자열 | | service_organization | 매개변수가 type 다음 중 하나인 경우 필수입니다. * 인증된 구성원 * 공인 서비스 조직 * 목록에 있는 구성원 * 목록에 있는 서비스 조직 고객에게 서비스를 제공하는 데 관여하는 서비스 조직 기록의 Sys_id입니다. 서비스 조직 \[sn_customer_service_organization\] 테이블에 있습니다. 주: 이 매개 변수를 전달하는 경우 계정, 연락처 또는 소비자 매개 변수도 전달해서는 안 됩니다. 이 service_organization 매개변수는 인스턴스에 Service Organization(com.snc.service_organization) 플러그인이 설치된 경우에만 사용할 수 있습니다. 데이터 유형: 문자열 | | sys_class_name | 관련 당사자 기록이 포함된 테이블입니다. 데이터 유형: 문자열 기본값: sn_install_base_related_party | | 유형 | 필수 작성할 관련 당사자 유형의 Sys_id입니다. 관련 당사자 구성 \[sn_customerservice_related_party_configuration\] 테이블에 있습니다. 가능한 유형: * 인증된 계정 * 인증된 소비자 * 인증된 접촉 창구 * 인증된 기고자 * 인증된 구성원 * 공인 서비스 조직 * 목록에 있는 계정 * 소비자 목록 * 접촉 창구 목록 * 목록에 있는 기고자 * 목록에 있는 구성원 * 목록에 있는 서비스 조직 데이터 유형: 문자열 | | 사용자 | 매개변수가 type 다음 관련 당사자 유형 중 하나인 경우 필수입니다. * 인증된 기고자 * 인증된 구성원 * 목록에 있는 기고자 * 목록에 있는 구성원 인증된 구성원 및 나열된 구성원의 경우, 이 사용자는 지정된 service_organization 기록과 연결되어 있어야 합니다. 관련 당사자 기록과 연결된 사용자 기록의 Sys_id입니다. 사용자 \[sys_user\] 테이블에 있습니다. 데이터 유형: 문자열 | [표 93. 요청 본문 매개변수(XML 또는 JSON)] ### 헤더 다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 [지원되는 REST API 헤더를](https://servicenow-prod.fluidtopics.net/JHL64oGR2SkU25ZTkfHy7g "REST(REpresentational State Transfer)는 웹상의 컴퓨터 시스템 간에 표준을 제공하여 서로 보다 쉽게 통신할 수 있게 지원하는 단순한 상태 비저장 아키텍처입니다.") 참조하세요. {#integrat-POST-relatedparties__entry__32}{#integrat-POST-relatedparties__accept-RESTAPI}{#integrat-POST-relatedparties__content_type-RESTAPI} | 헤더 | 설명 | |-|-| | 수용 | 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json | | 컨텐츠-형식 | 요청 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json | [표 94. 요청 헤더] {#integrat-POST-relatedparties__entry__38} | 헤더 | 설명 | |-|-| | 없음 | | [표 95. 응답 헤더] ### 상태 코드 다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 [REST API HTTP 응답 코드를](https://servicenow-prod.fluidtopics.net/JHL64oGR2SkU25ZTkfHy7g "REST(REpresentational State Transfer)는 웹상의 컴퓨터 시스템 간에 표준을 제공하여 서로 보다 쉽게 통신할 수 있게 지원하는 단순한 상태 비저장 아키텍처입니다.") 참조하세요. {#integrat-POST-relatedparties__entry__42}{#integrat-POST-relatedparties__entry-200-status-code}{#integrat-POST-relatedparties__entry-400-status-code}{#integrat-POST-relatedparties__entry-403-status-code}{#integrat-POST-relatedparties__entry-404-status-code}{#integrat-POST-relatedparties__entry-500-status-code} | 상태 코드 | 설명 | |-|-| | 200 | 성공입니다. 요청이 성공적으로 처리되었습니다. | | 400 | 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다. | | 403 | 금지되었습니다. 사용자에게 지정된 기록에 대한 액세스 권한이 없습니다. | | 404 | 찾을 수 없습니다. 요청한 항목을 찾을 수 없습니다. | | 500 | 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다. | [표 96. 상태 코드] ### 응답 본문 매개변수(JSON 또는 XML) {#integrat-POST-relatedparties__entry__54}{#integrat-POST-relatedparties__error-integration-entry}{#integrat-POST-relatedparties__error_detail-integration-entry}{#integrat-POST-relatedparties__error_message-integration-entry}{#integrat-POST-relatedparties__status-integration-entry}{#integrat-POST-relatedparties__sysparm_limit-integration-entry}{#integrat-POST-relatedparties__sysparm_offset-integration-entry} | 이름 | 설명 | |-|-| | 계정 | 관련 당사자 기록과 연결된 계정에 대한 상세 정보입니다. 데이터 유형: 객체 account": { "display_value": "String", "sys_id": "String" } | | account.display_value | 관련 당사자 기록과 연결된 계정의 텍스트 이름입니다. 이 값을 사용하여 UI에 계정 이름을 표시합니다. 데이터 유형: 문자열 | | account.sys_id | 관련 당사자 기록과 연결된 계정 기록의 Sys_id입니다. 데이터 유형: 문자열 | | 소비자 | 관련 당사자 기록과 연결된 소비자에 대한 상세 정보입니다. 데이터 유형: 객체 "consumer": { "display_value": "String", "sys_id": "String" } | | consumer.display_value | 관련 당사자 기록과 연결된 소비자의 텍스트 이름입니다. 이 값을 사용하여 UI에 소비자 이름을 표시합니다. 데이터 유형: 문자열 | | consumer.sys_id | 관련 당사자 기록과 연결된 소비자 기록의 Sys_id입니다. 데이터 유형: 문자열 | | 연락처 | 관련 당사자 기록을 담당하는 계정 연락처에 대한 상세 정보입니다. 데이터 유형: 객체 "contact": { "display_value": "String", "sys_id": "String" } | | contact.display_value | 관련 당사자 기록과 연결된 연락처의 텍스트 이름입니다. 이 값을 사용하여 UI에 연락처 이름을 표시합니다. 데이터 유형: 문자열 | | contact.sys_id | 관련 당사자 기록과 연결된 연락처 기록의 Sys_id입니다. 연락처 \[customer_contact\] 테이블에 있습니다. 데이터 유형: 문자열 | | 오류 | 요청을 처리하려고 할 때 발생한 오류에 대한 상세 정보입니다. 데이터 유형: 객체 "error": { "detail": "String", "message": "String" } | | 오류.상세 정보 | 관련 오류에 대한 추가 정보입니다. 데이터 유형: 문자열 | | 오류.메시지 | 요청을 실행하려고 할 때 발생한 문제를 설명하는 오류 메시지입니다. 데이터 유형: 문자열 | | install_base_item | 관련 당사자 기록과 연결된 설치 기반 항목에 대한 상세 정보입니다. 데이터 유형: 객체 "install_base_item": { "display_value": "String", "sys_id": "String" } | | install_base_item.display_value | 관련 당사자 기록과 연결된 설치 기반 항목의 텍스트 이름입니다. 이 값을 사용하여 UI에 설치 기반 항목 이름을 표시합니다. 데이터 유형: 문자열 | | install_base_item.sys_id | 관련 당사자 기록과 연결된 설치 기반 항목 기록의 Sys_id입니다. 데이터 유형: 문자열 | | 책임 | 설치 기반 정보의 접근 수준에 대한 세부 정보입니다. 데이터 유형: 객체 "responsibility": { "display_value": "String", "sys_id": "String" } | | responsibility.display_value | 설치 기반 정보에 대한 접근 수준에 대한 텍스트 표시 값입니다. 데이터 유형: 문자열 | | responsibility.sys_id | 연결된 책임 기록의 Sys_id입니다. 이 기록은 설치 기반 정보에 대한 액세스 수준을 정의합니다. 책임 정의 \[sn_customerservice_responsibility_def\] 테이블에 있습니다. 이 매개변수는 필드도 related_party 지정된 경우에만 유효합니다. 지정한 경우 및 responsibility 매개변수 모두 related_party 와 일치하는 설치 기반 항목만 반환합니다. 자세한 내용은 다음을 참조하십시오. [Configure related parties for items received](https://www.servicenow.com/docs/access?context=psds-add-related-parties-to-record&version=xanadu&pubname=xanadu-government-industry&ft:locale=en-US) 데이터 유형: 문자열 | | 상태 | 엔드포인트 호출의 상태입니다. 데이터 유형: 문자열 | | sys_class_name | 관련 당사자 기록이 포함된 테이블입니다. 데이터 유형: 문자열 기본값: sn_install_base_related_party | | sys_id | 연결된 관련 당사자 기록의 Sys_id입니다. 데이터 유형: 문자열 | | sysparm_limit | 반환된 기록 수입니다. 이 값이 원래 요청에 지정되지 않은 경우 기본값이 사용됩니다. 데이터 유형: 숫자 | | sysparm_offset | 기록이 평가 및 검색된 관련 테이블의 오프셋(시작 지점)입니다. 데이터 유형: 문자열 | | 유형 | 관련 당사자 기록과 연결된 연락처 유형에 대한 상세 정보입니다. 데이터 유형: 객체 "type": { "display_value": "String", "sys_id": "String" } | | type.display_value | 관련 당사자 기록과 연결된 연락처 유형의 텍스트 이름입니다. 이 값을 사용하여 UI에 연락처 유형을 표시합니다. 자세한 내용은 [Add related party configurations to cases, sold products, install bases, or service organizations](https://www.servicenow.com/docs/access?context=adding-related-party-config-to-case&version=xanadu&pubname=xanadu-customer-service-management&ft:locale=en-US) 문서를 참조하십시오. 가능한 유형: * 인증된 계정 * 인증된 소비자 * 인증된 접촉 창구 * 인증된 기고자 * 인증된 구성원 * 공인 서비스 조직 * 목록에 있는 계정 * 소비자 목록 * 접촉 창구 목록 * 목록에 있는 기고자 * 목록에 있는 구성원 * 목록에 있는 서비스 조직 데이터 유형: 문자열 | | type.sys_id | 관련 당사자 기록과 연결된 유형 기록의 Sys_id입니다. 데이터 유형: 문자열 | | 사용자 | 관련 당사자 기록과 연결된 사용자에 대한 상세 정보입니다. 데이터 유형: 객체 "user": { "display_value": "String", "sys_id": "String" } | | user.display_value | 관련 당사자 기록과 연결된 사용자의 텍스트 이름입니다. 이 값을 사용하여 UI에 사용자 이름을 표시합니다. 데이터 유형: 문자열 | | user.sys_id | 관련 당사자 기록과 연결된 사용자 기록의 Sys_id입니다. 사용자 \[sys_user\] 테이블에 있습니다. 데이터 유형: 문자열 | [ ] ### cURL 요청 다음 코드 예제에서는 이 엔드포인트를 호출하여 공인 계정 관련 레코드를 만들고 설치 기반 항목과 연결하는 방법을 보여 줍니다. curl "https://instance.servicenow.com/api/sn_install_base/integrations/relatedparties/f77c7542b7343300ece839a6ee11a991" \ --request POST \ --header "Accept:application/json" \ --header "Content-Type:application/json" \ --data "{ "contact":"0a232a0013691200042ab3173244b075", "type":"68ec8b2965e99110f87764df53db779f", "account":"86837a386f0331003b3c498f5d3ee4ca", "install_base_item":"f77c7542b7343300ece839a6ee11a991", "responsibility":"c009bbedb3730010700b4d43c6a8dcef", "sys_class_name":"sn_install_base_related_party" }" \ --user 'username':'password' 반환 결과: { "result": { "type": { "display_value":"Authorized Contact", "sys_id":"68ec8b2965e99110f87764df53db779f" }, "install_base_item": { "display_value":"KX Series - KX5000", "sys_id":"f77c7542b7343300ece839a6ee11a991" }, "sys_class_name":"sn_install_base_related_party", "sys_id":"4659539814ac6910f877ae314c1fb43a", "responsibility": { "display_value":"Authorized Representative", "sys_id":"c009bbedb3730010700b4d43c6a8dcef" }, "contact": { "display_value":"Cindy Contact", "sys_id":"dc0185d94f341200025ba3618110c77c" }, "account": { "display_value":"Boxeo", "value":"86837a386f0331003b3c498f5d3ee4ca" }, "status":"SUCCESS", } }