문제 티켓 오픈 API

문제 티켓 열기 API는 케이스 [sn_customerservice_case] 및 인시던트 [incident] 테이블에서 데이터를 생성, 업데이트 및 검색할 수 있는 엔드포인트를 제공합니다.

이 API를 사용하여 외부 티켓팅 시스템과 ServiceNow AI Platform.

이 API는 에서 사용할 수 ServiceNow Store있는 Telecommunications Assurance Workflows 애플리케이션에 포함되어 있습니다. 고객 서비스 케이스 [sn_customerservice_case] 테이블과 함께 이 API를 사용하려면 (com.sn_customerservice) 및 com.snc.install_base(Customer Service Install Base Management) 애플리케이션이 필요합니다.

이 API는 sn_ind_tsm_sdwan 네임스페이스 내에서 제공됩니다.

호출하는 사용자에게 ticket_integrator 역할이 있어야 합니다.

이 API는 필수 매개변수, 요청 본문 확인, 추가 REST 작업 및 필드 매핑에 대한 사용자 지정을 수행하도록 확장할 수 있습니다. 자세한 내용은 Trouble Ticket Open API 개발자 가이드.

Trouble Ticket Open API는 TM Forum Trouble Ticket Management API REST 사양의 구현입니다ServiceNow®. 이 구현은 TMF621 문제 티켓 관리 API REST 사양 릴리스 19, 2019년 6월을 기반으로 합니다. Trouble Ticket Open API는 TM Forum에서 적합성 인증을 받았습니다.

문제 티켓 - GET /sn_ind_tsm_sdwan/티켓/troubleTicket

케이스 [sn_customerservice_case] 및 인시던트 [incident] 테이블에서 모든 문제 티켓 기록의 목록을 검색합니다.

URL 형식

기본 URL: /api/sn_ind_tsm_sdwan/ticket/troubleTicket

지원되는 요청 매개변수

표 1. 경로 매개변수

이름	설명
없음

표 2. 쿼리 매개변수

이름	설명
필드	응답에서 반환할 필드 목록입니다. 잘못된 필드는 무시됩니다. 유효한 필드: 채널 creationDate 설명 href ID lastUpdate 이름 참고 관련 엔터티 관련당사자 severity 상태 ticketType @type 기본값: 모든 필드를 반환합니다. 데이터 유형: 문자열
ID	sys_id별로 문제 티켓을 필터링합니다. 지정된 sys_id 있는 티켓만 응답에 반환됩니다. 데이터 유형: 문자열
제한	반환할 최대 기록 수입니다. 이 기록 수를 초과하는 요청의 경우 매개변수를 사용하여 offset 기록 검색을 페이지 매김합니다. 기본값: 25 최대: 100 및 sn_ind_tsm_sdwan.pagination.max_limit 시스템 속성을 업데이트하여 기본값과 최대값을 sn_ind_tsm_sdwan.pagination.set_limit 변경할 수 있습니다. 데이터 유형: 숫자
오프셋	기록 검색을 시작할 시작 인덱스입니다. 이 값을 사용하여 기록 검색을 페이지 매김합니다. 이 기능을 사용하면 기록 수와 관계없이 관리 가능한 작은 청크로 모든 기록을 검색할 수 있습니다. 데이터 유형: 숫자 기본값: 0
severity	심각도별로 문제 티켓을 필터링합니다. 지정된 심각도를 가진 티켓만 응답에 반환됩니다. 데이터 유형: 문자열
상태	상태별로 문제 티켓을 필터링합니다. 지정된 상태의 티켓만 응답에 반환됩니다. 데이터 유형: 문자열
ticketType	티켓 유형별로 문제 티켓을 필터링합니다. 지정된 유형의 티켓만 응답에 반환됩니다. 유효한 값은 다음과 같습니다. 케이스 인시던트 데이터 유형: 문자열

표 3. 요청 본문 매개변수(JSON)

이름	설명
없음

헤더

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

표 4. 요청 헤더

헤더	설명
없음

표 5. 응답 헤더

헤더	설명
콘텐츠 범위	페이지 매김된 호출에서 반환된 콘텐츠의 범위입니다. 예를 들어, offset=2 및 limit=3인 경우 헤더의 Content-Range 값은 항목 3-5입니다.
콘텐츠-형식	응답 본문의 데이터 형식입니다. .만 지원합니다 application/json.
링크	쿼리 결과를 탐색할 수 있는 다음 링크가 포함되어 있습니다. 첫 번째 마지막 다음 이전
X-Total-Count	페이지 매김된 쿼리의 경우 이 헤더는 서버에서 사용할 수 있는 총 레코드 수를 지정합니다.

상태 코드

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

표 6. 상태 코드

상태 코드	설명
200	요청이 성공적으로 처리되었습니다. 응답으로 전체 자원이 반환됩니다(페이지 매김 없음).
206	응답으로 반환된 부분 자원(페이지 매김 포함).
400	잘못된 요청. 가능한 이유: 잘못된 경로 매개변수 잘못된 URI
404	기록 없음 쿼리 매개변수와 일치하는 기록을 테이블에서 찾을 수 없습니다.

응답 본문 매개변수(JSON)

이름	설명
채널	티켓이 생성된 연락 방법입니다. 데이터 유형: 객체 "channel":{ "name": "String" }
channel.name	연락 방법의 이름입니다. 케이스의 채널 [contact_type] 필드와 인시던트의 연락처 유형 [contact_type] 필드에 매핑합니다. 데이터 유형: 문자열
creationDate	케이스 또는 인시던트 기록이 생성된 날짜입니다. 작성됨 필드에 매핑합니다. 데이터 유형: 문자열
설명	티켓의 문제에 대한 설명입니다. 설명 필드에 매핑합니다. 데이터 유형: 문자열
href	케이스 또는 인시던트 기록에 대한 상대 링크입니다. 데이터 유형: 문자열
ID	케이스 또는 인시던트 기록의 sys_id입니다. 데이터 유형: 문자열
lastUpdate	기록이 마지막으로 업데이트된 날짜입니다. 업데이트된 필드에 매핑합니다. 데이터 유형: 문자열
이름	문제 티켓의 이름으로, 일반적으로 문제에 대한 간단한 설명입니다. 간단한 설명 필드에 매핑합니다. 데이터 유형: 문자열
참고	티켓에 대한 모든 의견 목록입니다. 이 목록에는 작업 메모가 포함되어 있지 않습니다. 데이터 유형: 배열 "note":[ { "author": "String", "date": "String", "text": "String", "@type": "String" } ]
note.@type	메모의 유형입니다. 의견만 반환되므로(작업 메모 아님) 이 값은 항상 의견입니다. 데이터 유형: 문자열
메모.작성자	코멘트를 생성한 POST 또는 PATCH 요청을 수행한 통합 사용자의 이름입니다 ServiceNow . 데이터 유형: 문자열
note.date	인스턴스에서 설명이 생성된 ServiceNow 날짜입니다. 데이터 유형: 문자열
note.text	설명 텍스트입니다. 데이터 유형: 문자열
관련 엔터티	영향을 받는 자산, 제품, 판매된 제품(제품 인벤토리), 구성 항목 또는 서비스의 목록입니다. 데이터 유형: 객체 배열 "relatedEntity": [ { "id": "String", "href": "String", "name": "String", "role": "String", "@referredType": "String", "@type": "String" } ]
relatedEntity.id	영향을 받는 항목 또는 서비스의 Sys_id입니다. 케이스의 경우 이 값은 다음 테이블 중 하나에서 가져옵니다. 자산 [alm_asset] 판매된 제품 [sn_install_base_sold_product] 테이블을 확장하는 제품 인벤토리 [sn_prd_invt_product_inventory] 제품 모델 [cmdb_model] 판매된 제품 [sn_install_base_sold_product] 인시던트의 경우 이 값은 다음 테이블 중 하나에서 가져옵니다. 구성 항목 [cmdb_ci] 서비스 [cmdb_ci_service] 데이터 유형: 문자열
relatedEntity.href	빈 문자열을 반환합니다. 데이터 유형: 문자열
relatedEntity.name	영향을 받는 항목 또는 서비스의 이름입니다. 데이터 유형: 문자열
relatedEntity.role	영향을 받는 항목 또는 서비스에 대한 설명입니다. 데이터 유형: 문자열
relatedEntity.@referredType	항목 또는 서비스의 유형입니다. 케이스 티켓의 유효한 값: asset 제품 product_inventory 인시던트 티켓의 유효한 값: cmdb_ci cmdb_ci_service 데이터 유형: 문자열
relatedEntity.@type	이 값은 항상 relatedEntity입니다. 데이터 유형: 문자열
관련당사자	티켓의 연락처에 대한 상세 정보입니다. 데이터 유형: 객체 배열 "relatedParty": [ { "id": "String", "name": "String", "@referredType": "String" } ]
relatedParty.id	관련 당사자의 Sys_id입니다. 티켓 유형 및 관련 당사자 유형에 따라 다음 테이블에서 sys_id 수 있습니다. 케이스: 계정 [customer_account]; 관련 공급업체 유형은 고객임 연락처 [customer_contact]; 관련 공급업체 유형이 customer_contact 인시던트: 회사 [core_company]; 관련 공급업체 유형은 고객임 사용자 [sys_user]; 관련 공급업체 유형이 customer_contact 케이스 또는 인시던트: 그룹 [sys_user_group]; 관련 공급업체 유형이 assignment_group 사용자 [sys_user]; 관련 공급업체 유형이 assigned_to 데이터 유형: 문자열
relatedParty.name	관련 당사자의 이름입니다. 데이터 유형: 문자열
relatedParty.@referredType	관련 당사자의 유형입니다. 가능한 값: assigned_to: 티켓에서 작업에 할당된 사용자입니다. assignment_group: 티켓에서 작업에 할당된 그룹입니다. 고객: 티켓의 회사 또는 계정입니다. customer_contact: 티켓의 발신자 또는 연락처입니다. 데이터 유형: 문자열
severity	문제 티켓에서 설명하는 문제의 심각도입니다. 우선순위 필드를 매핑합니다. 데이터 유형: 문자열
상태	문제 티켓의 현재 상태입니다. 상태 필드에 매핑합니다. 데이터 유형: 문자열
ticketType	티켓의 유형입니다. 가능한 값: 케이스 인시던트 데이터 유형: 문자열
@type	이 값은 항상 TroubleTicket입니다. 데이터 유형: 문자열

cURL 요청

이 예에서는 처음 5개의 문제 티켓 케이스 기록에 대해 지정된 필드를 반환합니다.

curl "https://instance.servicenow.com/api/sn_ind_tsm_sdwan/ticket/troubleTicket?limit=5&fields=id%2Cname%2Cdescription%2Cstatus%2Cseverity%2CticketType&ticketType=case" \
--request GET \
--user 'username':'password'

응답 본문.

[
   {
      "id": "0004609eb9830110f877b3758cd21d37",
      "name": "Compliant Over 2796",
      "description": "checkNo2796",
      "status": "New",
      "severity": "3 - Moderate",
      "ticketType": "Case"
   },
   {
      "id": "000560d2b9c30110f877b3758cd21d36",
      "name": "Compliant Over 4696",
      "description": "checkNo4696",
      "status": "New",
      "severity": "3 - Moderate",
      "ticketType": "Case"
   },
   {
      "id": "0007ac5eb9c30110f877b3758cd21d34",
      "name": "Compliant Over 8817",
      "description": "checkNo8817",
      "status": "New",
      "severity": "3 - Moderate",
      "ticketType": "Case"
   },
   {
      "id": "0007ac5eb9c30110f877b3758cd21d39",
      "name": "Compliant Over 8819",
      "description": "checkNo8819",
      "status": "New",
      "severity": "3 - Moderate",
      "ticketType": "Case"
   },
   {
      "id": "0007ac5eb9c30110f877b3758cd21d3e",
      "name": "Compliant Over 8821",
      "description": "checkNo8821",
      "status": "New",
      "severity": "3 - Moderate",
      "ticketType": "Case"
   }
]

문제 티켓 - GET /sn_ind_tsm_sdwan/ticket/troubleTicket/{id}

케이스 [sn_customerservice_case] 또는 인시던트 [incident] 테이블에서 지정된 기록을 조회합니다.

URL 형식

기본 URL: /api/sn_ind_tsm_sdwan/ticket/troubleTicket/{id}

지원되는 요청 매개변수

표 7. 경로 매개변수

이름	설명
ID	검색할 케이스 또는 인시던트 기록의 Sys_id입니다. 데이터 유형: 문자열 테이블: 케이스 [sn_customerservice_case] 또는 인시던트 [incident]

표 8. 쿼리 매개변수

이름	설명
필드	응답에서 반환할 필드 목록입니다. 잘못된 필드는 무시됩니다. 유효한 값은 다음과 같습니다. 채널 creationDate 설명 href ID lastUpdate 이름 참고 관련 엔터티 관련당사자 severity 상태 ticketType @type 데이터 유형: 문자열 기본값: 모든 필드를 반환합니다.

표 9. 요청 본문 매개변수(JSON)

이름	설명
없음

헤더

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

표 10. 요청 헤더

헤더	설명
수용	응답 본문의 데이터 형식입니다. application/json만 지원합니다.

표 11. 응답 헤더

헤더	설명
없음

상태 코드

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

표 12. 상태 코드

상태 코드	설명
200	성공입니다. 요청이 성공적으로 처리되었습니다.
400	잘못된 요청입니다. 다음 중 하나 이상의 이유로 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다. 잘못된 경로 매개변수입니다. 잘못된 URI입니다.
404	기록 없음 ID와 관련된 기록을 케이스 [sn_customerservice_case] 또는 인시던트 [incident] 테이블에서 찾을 수 없습니다.

응답 본문 매개변수(JSON)

이름	설명
채널	티켓이 생성된 연락 방법입니다. 데이터 유형: 객체 "channel":{ "name": "String" }
channel.name	연락 방법의 이름입니다. 케이스의 채널 [contact_type] 필드와 인시던트의 연락처 유형 [contact_type] 필드에 매핑합니다. 데이터 유형: 문자열
creationDate	케이스 또는 인시던트 기록이 생성된 날짜입니다. 작성됨 필드에 매핑합니다. 데이터 유형: 문자열
설명	티켓의 문제에 대한 설명입니다. 설명 필드에 매핑합니다. 데이터 유형: 문자열
href	케이스 또는 인시던트 기록에 대한 상대 링크입니다. 데이터 유형: 문자열
ID	케이스 또는 인시던트 기록의 Sys_id입니다. 데이터 유형: 문자열
lastUpdate	기록이 마지막으로 업데이트된 날짜입니다. 업데이트된 필드에 매핑합니다. 데이터 유형: 문자열
이름	문제 티켓의 이름으로, 일반적으로 문제에 대한 간단한 설명입니다. 간단한 설명 필드에 매핑합니다. 데이터 유형: 문자열
참고	티켓의 모든 의견 목록입니다. 이 목록에는 작업 메모가 포함되어 있지 않습니다. 데이터 유형: 객체 배열 "note":[ { "author": "String", "date": "String", "text": "String", "@type": "String" } ]
note.@type	메모의 유형입니다. 의견만 반환되므로(작업 메모 아님) 이 값은 항상 의견입니다. 데이터 유형: 문자열
메모.작성자	코멘트를 작성한 사용자의 이름입니다. 데이터 유형: 문자열
note.date	인스턴스에서 설명이 생성된 ServiceNow 날짜입니다. 데이터 유형: 문자열
note.text	설명 텍스트입니다. 데이터 유형: 문자열
관련 엔터티	영향을 받는 자산, 제품, 판매된 제품(제품 인벤토리), 구성 항목 또는 서비스의 목록입니다. 데이터 유형: 객체 배열 "relatedEntity": [ { "id": "String", "href": "String", "name": "String", "role": "String", "@referredType": "String", "@type": "String" } ]
relatedEntity.id	영향을 받는 항목 또는 서비스의 Sys_id입니다. 케이스의 경우 이 값은 다음 테이블 중 하나에서 가져옵니다. 자산 [alm_asset] 판매된 제품 [sn_install_base_sold_product] 테이블을 확장하는 제품 인벤토리 [sn_prd_invt_product_inventory] 제품 모델 [cmdb_model] 판매된 제품 [sn_install_base_sold_product] 인시던트의 경우 이 값은 다음 테이블 중 하나에서 가져옵니다. 구성 항목 [cmdb_ci] 서비스 [cmdb_ci_service] 데이터 유형: 문자열
relatedEntity.href	빈 문자열을 반환합니다. 데이터 유형: 문자열
relatedEntity.name	영향을 받는 항목 또는 서비스의 이름입니다. 데이터 유형: 문자열
relatedEntity.role	영향을 받는 항목 또는 서비스에 대한 설명입니다. 데이터 유형: 문자열
relatedEntity.@referredType	항목 또는 서비스의 유형입니다. 케이스 티켓의 유효한 값: asset 제품 product_inventory 인시던트 티켓의 유효한 값: cmdb_ci cmdb_ci_service 데이터 유형: 문자열
relatedEntity.@type	이 값은 항상 relatedEntity입니다. 데이터 유형: 문자열
관련당사자	티켓의 연락처에 대한 상세 정보입니다. 데이터 유형: 객체 배열 "relatedParty": [ { "id": "String", "name": "String", "@referredType": "String" } ]
relatedParty.id	관련 당사자의 Sys_id입니다. 티켓 유형 및 관련 당사자 유형에 따라 다음 테이블에서 sys_id 수 있습니다. 케이스: 계정 [customer_account]; 관련 공급업체 유형은 고객임 연락처 [customer_contact]; 관련 공급업체 유형이 customer_contact 인시던트: 회사 [core_company]; 관련 공급업체 유형은 고객임 사용자 [sys_user]; 관련 공급업체 유형이 customer_contact 케이스 또는 인시던트: 그룹 [sys_user_group]; 관련 공급업체 유형이 assignment_group 사용자 [sys_user]; 관련 공급업체 유형이 assigned_to 데이터 유형: 문자열
relatedParty.name	관련 당사자의 이름입니다. 데이터 유형: 문자열
relatedParty.@referredType	관련 당사자의 유형입니다. 가능한 값: assigned_to: 티켓에서 작업에 할당된 사용자입니다. assignment_group: 티켓에서 작업에 할당된 그룹입니다. 고객: 티켓의 회사 또는 계정입니다. customer_contact: 티켓의 발신자 또는 연락처입니다. 데이터 유형: 문자열
severity	문제 티켓에서 설명하는 문제의 심각도입니다. 우선순위 필드를 매핑합니다. 데이터 유형: 문자열
상태	문제 티켓의 현재 상태입니다. 상태 필드에 매핑합니다. 데이터 유형: 문자열
ticketType	티켓의 유형입니다. 가능한 값: 케이스 인시던트 데이터 유형: 문자열
@type	이 값은 항상 TroubleTicket입니다. 데이터 유형: 문자열

cURL 요청

이 예에서는 케이스 [sn_customerservice_case] 테이블에서 문제 티켓 기록을 검색합니다.

curl "https://instance.servicenow.com/api/sn_ind_tsm_sdwan/ticket/troubleTicket/6467508d47e345508761b955d36d43f6" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

응답 본문.

{
    "id": "370415f03c20e910f8772f1bc332b31b",
    "href": "/api/sn_ind_tsm_sdwan/ticket/troubleTicket/370415f03c20e910f8772f1bc332b31b",
    "creationDate": "2023-01-19 22:39:28",
    "lastUpdate": "2023-01-19 22:41:39",
    "description": "Router is not working, my devices cannot detect any signals from the router. First button from the left is flashing red, all others are black. Resetting the router does not solve the problem, I need urgent assistance.",
    "severity": "2 - High",
    "ticketType": "Case",
    "name": "My router is not working properly",
    "status": "Open",
    "channel": {
        "name": "e_bonding"
    },
    "relatedParty": [
        {
            "id": "ffc68911c35420105252716b7d40dd55",
            "name": "Funco Intl",
            "@referredType": "customer"
        },
        {
            "id": "eaf68911c35420105252716b7d40ddde",
            "name": "Sally Thomas",
            "@referredType": "customer_contact"
        },
        {
            "id": "",
            "name": "",
            "@referredType": "assignment_group"
        },
        {
            "id": "",
            "name": "",
            "@referredType": "assigned_to"
        }
    ],
    "relatedEntity": [
        {
            "id": "b7fa12c7532520103b6bddeeff7b123b",
            "href": "",
            "name": "Deduplication and Compression PRD00001965",
            "role": "This is the product associated with the case.",
            "@type": "relatedEntity",
            "@referredType": "product"
        },
        {
            "id": "71e73d87c3e23010ff00ed23a140dde8",
            "href": "",
            "name": "",
            "role": "This is the asset associated with the case.",
            "@type": "relatedEntity",
            "@referredType": "asset"
        },
        {
            "id": "a1913c3577b301108e191e599a5a99e8",
            "href": "",
            "name": "Deduplication and Compression PI0000037",
            "role": "This is the product inventory associated with the case.",
            "@type": "relatedEntity",
            "@referredType": "product_inventory"
        }
    ],
    "note": [
        {
            "text": "This is a testing comment<script>gs.info('Hello World')</script>",
            "date": "2023-01-19 14:41:39",
            "author": "System Administrator",
            "@type": "comments"
        },
        {
            "text": "This is a testing comment<script>gs.info('Hello World')</script>",
            "date": "2023-01-19 14:39:28",
            "author": "System Administrator",
            "@type": "comments"
        }
    ],
    "@type": "TroubleTicket"
}

문제 티켓 - GET /sn_ind_tsm_sdwan/troubleticket/{ticketType}/{id}

케이스 [sn_customerservice_case] 또는 인시던트 [incident] 테이블에서 지정된 기록을 조회합니다.

중요사항:

릴리스부터 Tokyo 이 엔드포인트는 더 이상 사용되지 않습니다. 이 엔드포인트의 새 버전은 입니다 문제 티켓 - GET /sn_ind_tsm_sdwan/ticket/troubleTicket/{id}.

URL 형식

기본 URL: /api/sn_ind_tsm_sdwan/troubleticket/{ticketType}/{id}

지원되는 요청 매개변수

표 13. 경로 매개변수

이름	설명
ticketType	티켓의 유형입니다. 이 값은 케이스 [sn_customerservice_case] 또는 인시던트 [incident] 테이블에서 기록을 검색할지 여부를 결정합니다. 유효한 값은 다음과 같습니다. 케이스 인시던트 데이터 유형: 문자열
ID	검색할 케이스 또는 인시던트 기록의 Sys_id입니다. 데이터 유형: 문자열

표 14. 쿼리 매개변수

이름	설명
필드	응답에 반환할 쉼표로 구분된 필드 목록입니다. 잘못된 필드는 무시됩니다. 이 값이 전달되지 않으면 모든 필드가 반환됩니다. 유효한 필드: 채널 creationDate 설명 ID lastUpdate 이름 참고 관련 엔터티 관련당사자 severity 상태 ticketType @type 데이터 유형: 문자열

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

이름	설명
없음

헤더

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

표 16. 요청 헤더

헤더	설명
수용	응답 본문의 데이터 형식입니다. application/json만 지원합니다.

표 17. 응답 헤더

헤더	설명
없음

상태 코드

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

표 18. 상태 코드

상태 코드	설명
200	성공입니다. 요청이 성공적으로 처리되었습니다.
400	잘못된 요청입니다. 다음 중 하나 이상의 이유로 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다. 잘못된 경로 매개변수입니다. 잘못된 URI입니다.
404	기록 없음 ID와 관련된 기록을 케이스 [sn_customerservice_case] 또는 인시던트 [incident] 테이블에서 찾을 수 없습니다.

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

이름	설명
@type	이 값은 항상 TroubleTicket입니다. 데이터 유형: 문자열
채널	티켓이 생성된 연락 방법입니다. 데이터 유형: 객체 "channel":{ "name": "String" }
channel.name	연락 방법의 이름입니다. 케이스의 채널 [contact_type] 필드와 인시던트의 연락처 유형 [contact_type] 필드에 매핑합니다. 데이터 유형: 문자열
creationDate	케이스 또는 인시던트 기록이 생성된 날짜입니다. 작성됨 필드에 매핑합니다. 데이터 유형: 문자열
설명	티켓의 문제에 대한 설명입니다. 설명 필드에 매핑합니다. 데이터 유형: 문자열
ID	케이스 또는 인시던트 기록의 Sys_id입니다. 데이터 유형: 문자열
lastUpdate	기록이 마지막으로 업데이트된 날짜입니다. 업데이트된 필드에 매핑합니다. 데이터 유형: 문자열
이름	문제 티켓의 이름으로, 일반적으로 문제에 대한 간단한 설명입니다. 간단한 설명 필드에 매핑합니다. 데이터 유형: 문자열
참고	티켓의 모든 의견 목록입니다. 이 목록에는 작업 메모가 포함되어 있지 않습니다. 데이터 유형: 객체 배열 "note": [ { "author": "String", "date": "String", "text": "String", "@type": "String" } ]
note.@type	메모의 유형입니다. 의견만 반환되므로(작업 메모 아님) 이 값은 항상 의견입니다. 데이터 유형: 문자열
메모.작성자	ServiceNow 코멘트를 생성한 POST 또는 PATCH 요청을 수행한 통합 사용자의 이름입니다. 데이터 유형: 문자열
note.date	인스턴스에서 설명이 생성된 ServiceNow 날짜입니다. 데이터 유형: 문자열
note.text	설명 텍스트입니다. 데이터 유형: 문자열
관련 엔터티	영향을 받는 자산, 제품, 판매된 제품(제품 인벤토리), 구성 항목 또는 서비스의 목록입니다. 데이터 유형: 객체 배열 "relatedEntity": [ { "id": "String", "href": "String", "name": "String", "role": "String", "@referredType": "String", "@type": "String" } ]
relatedEntity.id	영향을 받는 항목 또는 서비스의 Sys_id입니다. 케이스의 경우 이 값은 다음 테이블 중 하나에서 가져옵니다. 자산 [alm_asset] 판매된 제품 [sn_install_base_sold_product] 테이블을 확장하는 제품 인벤토리 [sn_prd_invt_product_inventory] 제품 모델 [cmdb_model] 판매된 제품 [sn_install_base_sold_product] 인시던트의 경우 이 값은 다음 테이블 중 하나에서 가져옵니다. 구성 항목 [cmdb_ci] 서비스 [cmdb_ci_service] 데이터 유형: 문자열
relatedEntity.href	빈 문자열을 반환합니다. 데이터 유형: 문자열
relatedEntity.name	영향을 받는 항목 또는 서비스의 이름입니다. 데이터 유형: 문자열
relatedEntity.role	영향을 받는 항목 또는 서비스에 대한 설명입니다. 데이터 유형: 문자열
relatedEntity.@referredType	항목 또는 서비스의 유형입니다. 케이스 티켓의 유효한 값: asset 제품 product_inventory 인시던트 티켓의 유효한 값: cmdb_ci cmdb_ci_service 데이터 유형: 문자열
relatedEntity.@type	이 값은 항상 relatedEntity입니다. 데이터 유형: 문자열
관련당사자	티켓과 연결된 회사 및 접촉 창구에 대한 상세 정보입니다. 데이터 유형: 객체 배열 "relatedParty": [ { "id": "String", "name": "String", "@referredType": "String" } ]
relatedParty.@referredType	관련 당사자의 유형입니다. 유효한 값은 다음과 같습니다. 고객: 티켓의 회사 또는 계정입니다. customer_contact: 티켓의 발신자 또는 연락처입니다. 데이터 유형: 문자열
relatedParty.id	관련 당사자의 Sys_id입니다. 연락처나 사용자(호출자)를 제공하면 해당 계정이나 회사가 티켓에 자동으로 채워집니다. 데이터 유형: 문자열 테이블: 케이스의 경우 연락처[customer_contact] 또는 계정[customer_account] 테이블의 sys_id입니다. 인시던트의 경우 sys_id는 사용자 [sys_user] 또는 회사 [core_company] 테이블에서 가져옵니다.
relatedParty.name	관련 당사자의 이름입니다. 케이스의 경우 접촉 창구 또는 계정 필드에 매핑됩니다. 인시던트의 경우 호출자 또는 회사 필드에 매핑합니다. 데이터 유형: 문자열
severity	문제 티켓에서 설명하는 문제의 심각도입니다. 우선순위 필드를 매핑합니다. 데이터 유형: 문자열
상태	문제 티켓의 현재 상태입니다. 필드에 매핑합니다. 데이터 유형: 문자열
ticketType	티켓의 유형(케이스 또는 인시던트)입니다. 데이터 유형: 문자열

cURL 요청

이 예에서는 케이스의 이름, 설명, 심각도 및 상태를 가져옵니다.

curl "https://instance.servicenow.com/api/sn_ind_tsm_sdwan/troubleticket/case/a78e2c8cdb68b41015364c9b0b96193e?fields=name%2Cdescription%2Cseverity%2Cstatus" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

응답 본문.

{
  "name": "Short description of issue",
  "description": "Example description of an issue",
  "severity": "2 - High",
  "status": "Open"
}

문제 티켓 - PATCH /sn_ind_tsm_sdwan/ticket/troubleTicket/{id}

케이스 [sn_customerservice_case] 또는 인시던트 [incident] 테이블에서 지정된 기록을 업데이트합니다.

URL 형식

기본 URL: /api/sn_ind_tsm_sdwan/ticket/troubleTicket/{id}

지원되는 요청 매개변수

표 19. 경로 매개변수

이름	설명
ID	업데이트할 케이스 또는 인시던트 기록의 Sys_id입니다. 데이터 유형: 문자열 테이블: 케이스 [sn_customerservice_case] 또는 인시던트 [incident]

표 20. 쿼리 매개변수

이름	설명
없음

표 21. 요청 본문 매개변수(JSON)

이름	설명
채널	티켓이 생성된 연락 방법입니다. 데이터 유형: 객체 "channel":{ "name": "String" }
channel.name	연락 방법의 이름입니다. 케이스의 채널 [contact_type] 필드와 인시던트의 연락처 유형 [contact_type] 필드에 매핑합니다. 유효한 값은 contact_type 필드에 대한 선택 사항입니다. 선택 레이블 또는 값을 제공할 수 있습니다. 예를 들어 가상 에이전트 또는 virtual_agent입니다. 데이터 유형: 문자열
설명	문제에 대한 설명입니다. 설명 필드에 매핑합니다. 데이터 유형: 문자열
이름	문제 티켓의 이름으로, 일반적으로 문제에 대한 간단한 설명입니다. 간단한 설명 필드에 매핑합니다. 데이터 유형: 문자열
참고	티켓에 추가할 작업 메모 및 코멘트 목록입니다. 데이터 유형: 객체 배열 "note":[ { "text": "String", "@type": "String" } ]
note.@type	메모의 유형입니다. 이 값은 메모가 작업 메모 필드에 기록되는지 또는 추가 의견 필드에 기록되는지를 결정합니다. 유효한 값은 다음과 같습니다. 설명 work_notes 데이터 유형: 문자열
note.text	메모 텍스트. 작업 메모 또는 추가 의견 필드에 매핑합니다. 데이터 유형: 문자열
관련 엔터티	영향을 받는 자산, 제품, 판매된 제품(제품 인벤토리), 구성 항목 또는 서비스의 목록입니다. 데이터 유형: 객체 배열 "relatedEntity": [ { "id": "String", "@referredType": "String" } ]
relatedEntity.id	영향을 받는 항목 또는 서비스의 Sys_id입니다. 케이스의 경우 이 값은 다음 테이블 중 하나에서 가져옵니다. 자산 [alm_asset] 판매된 제품 [sn_install_base_sold_product] 테이블을 확장하는 제품 인벤토리 [sn_prd_invt_product_inventory] 제품 모델 [cmdb_model] 판매된 제품 [sn_install_base_sold_product] 인시던트의 경우 이 값은 다음 테이블 중 하나에서 가져옵니다. 구성 항목 [cmdb_ci] 서비스 [cmdb_ci_service] 데이터 유형: 문자열
relatedEntity.@referredType	항목 또는 서비스의 유형입니다. 케이스 티켓의 유효한 값: asset 제품 product_inventory 인시던트 티켓의 유효한 값: cmdb_ci cmdb_ci_service 데이터 유형: 문자열
관련당사자	티켓의 연락처에 대한 상세 정보입니다. 케이스의 경우 이 매개변수가 접촉 창구 또는 계정 필드를 채웁니다. 인시던트의 경우 이 매개변수는 호출자 또는 회사 필드를 채웁니다. 데이터 유형: 객체 배열 "relatedParty": [ { "id": "String", "@referredType": "String" } ]
relatedParty.id	관련 당사자의 Sys_id입니다. 연락처나 사용자(호출자)를 제공하면 해당 계정이나 회사가 티켓에 자동으로 채워집니다. 데이터 유형: 문자열 테이블: 케이스의 경우 연락처[customer_contact] 또는 계정[customer_account] 테이블의 sys_id입니다. 인시던트의 경우 sys_id는 사용자 [sys_user] 또는 회사 [core_company] 테이블에서 가져옵니다.
relatedParty.@referredType	관련 당사자의 유형입니다. 유효한 값은 다음과 같습니다. 고객: 티켓의 회사 또는 계정입니다. customer_contact: 티켓의 발신자 또는 연락처입니다. 데이터 유형: 문자열
severity	문제 티켓에서 설명하는 문제의 심각도입니다. 우선순위 필드를 매핑합니다. 유효한 값은 다음과 같습니다. 1: 중요 2: 높음 3: 보통 4: 낮음 5: 계획. 인시던트만. 우선순위 필드에 대해 선택하는 것이 유효한 값입니다. 선택 값만 제공해야 합니다. 예: 1. 잘못된 값이 제공되면 심각도가 낮음으로 설정됩니다. 데이터 유형: 문자열
상태	문제 티켓의 현재 상태입니다. 상태 필드에 매핑합니다. 유효한 값은 상태 필드에 대한 선택 사항입니다. 선택 레이블 또는 값을 제공할 수 있습니다. 예를 들어, 신규 또는 1입니다. 데이터 유형: 문자열

헤더

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

표 22. 요청 헤더

헤더	설명
수용	응답 본문의 데이터 형식입니다. application/json만 지원합니다.
컨텐츠-형식	요청 본문의 데이터 형식입니다. application/json만 지원합니다.

표 23. 응답 헤더

헤더	설명
없음

상태 코드

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

표 24. 상태 코드

상태 코드	설명
200	성공입니다. 요청이 성공적으로 처리되었습니다.
400	잘못된 요청입니다. 다음 중 하나 이상의 이유로 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다. 잘못된 경로 매개변수입니다. 잘못된 URI입니다.
404	기록 없음 ID와 관련된 기록을 케이스 [sn_customerservice_case] 또는 인시던트 [incident] 테이블에서 찾을 수 없습니다.

응답 본문 매개변수(JSON)

이름	설명
채널	티켓이 생성된 연락 방법입니다. 데이터 유형: 객체 "channel":{ "name": "String" }
channel.name	연락 방법의 이름입니다. 데이터 유형: 문자열
creationDate	기록이 생성된 날짜입니다. 데이터 유형: 문자열
설명	티켓의 문제에 대한 설명입니다. 데이터 유형: 문자열
href	케이스 또는 인시던트 기록에 대한 상대 링크입니다. 데이터 유형: 문자열
ID	케이스 또는 인시던트 기록의 Sys_id입니다. 데이터 유형: 문자열
lastUpdate	기록이 마지막으로 업데이트된 날짜입니다. 데이터 유형: 문자열
이름	문제 티켓의 이름으로, 일반적으로 문제에 대한 간단한 설명입니다. 데이터 유형: 문자열
참고	티켓의 모든 의견 목록입니다. 이 목록에는 작업 메모가 포함되어 있지 않습니다. 데이터 유형: 객체 배열 "note":[ { "author": "String", "date": "String", "text": "String", "@type": "String" } ]
note.@type	메모의 유형입니다. 의견만 반환되므로(작업 메모 아님) 이 값은 항상 의견입니다. 데이터 유형: 문자열
메모.작성자	코멘트를 작성한 사용자의 이름입니다. 데이터 유형: 문자열
note.date	인스턴스에서 설명이 생성된 ServiceNow 날짜입니다. 데이터 유형: 문자열
note.text	설명 텍스트입니다. 데이터 유형: 문자열
관련 엔터티	영향을 받는 자산, 제품, 판매된 제품(제품 인벤토리), 구성 항목 또는 서비스의 목록입니다. 데이터 유형: 객체 배열 "relatedEntity": [ { "id": "String", "href": "String", "name": "String", "role": "String", "@referredType": "String", "@type": "String" } ]
relatedEntity.id	영향을 받는 항목 또는 서비스의 Sys_id입니다. 케이스의 경우 이 값은 다음 테이블 중 하나에서 가져옵니다. 자산 [alm_asset] 판매된 제품 [sn_install_base_sold_product] 테이블을 확장하는 제품 인벤토리 [sn_prd_invt_product_inventory] 제품 모델 [cmdb_model] 판매된 제품 [sn_install_base_sold_product] 인시던트의 경우 이 값은 다음 테이블 중 하나에서 가져옵니다. 구성 항목 [cmdb_ci] 서비스 [cmdb_ci_service] 데이터 유형: 문자열
relatedEntity.href	빈 문자열을 반환합니다. 데이터 유형: 문자열
relatedEntity.name	영향을 받는 항목 또는 서비스의 이름입니다. 데이터 유형: 문자열
relatedEntity.role	영향을 받는 항목 또는 서비스에 대한 설명입니다. 데이터 유형: 문자열
relatedEntity.@referredType	항목 또는 서비스의 유형입니다. 케이스 티켓의 유효한 값: asset 제품 product_inventory 인시던트 티켓의 유효한 값: cmdb_ci cmdb_ci_service 데이터 유형: 문자열
relatedEntity.@type	이 값은 항상 relatedEntity입니다. 데이터 유형: 문자열
관련당사자	티켓의 연락처에 대한 상세 정보입니다. 데이터 유형: 객체 배열 "relatedParty": [ { "id": "String", "name": "String", "@referredType": "String" } ]
relatedParty.id	관련 당사자의 Sys_id입니다. 티켓 유형 및 관련 당사자 유형에 따라 다음 테이블에서 sys_id 수 있습니다. 케이스: 계정 [customer_account]; 관련 공급업체 유형은 고객임 연락처 [customer_contact]; 관련 공급업체 유형이 customer_contact 인시던트: 회사 [core_company]; 관련 공급업체 유형은 고객임 사용자 [sys_user]; 관련 공급업체 유형이 customer_contact 케이스 또는 인시던트: 그룹 [sys_user_group]; 관련 공급업체 유형이 assignment_group 사용자 [sys_user]; 관련 공급업체 유형이 assigned_to 데이터 유형: 문자열
relatedParty.name	관련 당사자의 이름입니다. 데이터 유형: 문자열
relatedParty.@referredType	관련 당사자의 유형입니다. 가능한 값: assigned_to: 티켓에서 작업에 할당된 사용자입니다. assignment_group: 티켓에서 작업에 할당된 그룹입니다. 고객: 티켓의 회사 또는 계정입니다. customer_contact: 티켓의 발신자 또는 연락처입니다. 데이터 유형: 문자열
severity	문제 티켓에서 설명하는 문제의 심각도입니다. 데이터 유형: 문자열
상태	문제 티켓의 현재 상태입니다. 데이터 유형: 문자열
ticketType	티켓의 유형입니다. 가능한 값: 케이스 인시던트 데이터 유형: 문자열
@type	이 값은 항상 TroubleTicket입니다. 데이터 유형: 문자열

cURL 요청

이 예에서는 케이스 기록을 업데이트합니다.

curl "https://instance.servicenow.com/api/sn_ind_tsm_sdwan/ticket/troubleTicket/6467508d47e345508761b955d36d43f6" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
   description: "Updated description",
   "note": [
      {
         "text": "Adding another comment",
         "@type": "comments"
      }
   ]
}" \
--user 'username':'password'

응답 본문.

{
   "id": "6467508d47e345508761b955d36d43f6",
   "href": "/api/sn_ind_tsm_sdwan/ticket/troubleTicket/6467508d47e345508761b955d36d43f6",
   "creationDate": "2022-05-16 23:38:55",
   "lastUpdate": "2022-05-16 23:48:42",
   "description": "Updated description",
   "severity": "2 - High",
   "ticketType": "Case",
   "name": "Laptop problem",
   "status": "New",
   "channel": {
      "name": "web"
   },
   "relatedParty": [
      {
         "id": "",
         "name": "",
         "@referredType": "customer"
      },
      {
         "id": "62826bf03710200044e0bfc8bcbe5df1",
         "name": "",
         "@referredType": "customer_contact"
      },
      {
         "id": "",
         "name": "",
         "@referredType": "assignment_group"
      },
      {
         "id": "",
         "name": "",
         "@referredType": "assigned_to"
      }
   ],
   "relatedEntity": [
      {
         "id": "",
         "href": "",
         "name": "",
         "role": "This is the product associated with the case",
         "@type": "relatedEntity",
         "@referredType": "product"
      },
      {
         "id": "74a9ec0d3790200044e0bfc8bcbe5d7f",
         "href": "",
         "name": "P1000597 - Apple MacBook Pro 15\"",
         "role": "This is the asset associated with the case",
         "@type": "relatedEntity",
         "@referredType": "asset"
      }
      {
         "id": "a1913c3577b301108e191e599a5a99e8",
         "href": "",
         "name": "Deduplication and Compression PI0000037",
         "role": "This is the product inventory associated with the case.",
         "@type": "relatedEntity",
         "@referredType": "product_inventory"
      }
   ],
   "note": [
      {
         "text": "Adding another comment",
         "date": "2022-05-16 16:48:42",
         "author": "admin",
         "@type": "comments"
      },
      {
         "text": "Comment about this case",
         "date": "2022-05-16 16:38:55",
         "author": "admin",
         "@type": "comments"
      }
   ],
   "@type": "TroubleTicket"
}

문제 티켓 - PATCH /sn_ind_tsm_sdwan/troubleticket/{ticketType}/{id}

케이스 [sn_customerservice_case] 또는 인시던트 [incident] 테이블의 기록을 업데이트합니다.

중요사항:

릴리스부터 Tokyo 이 엔드포인트는 더 이상 사용되지 않습니다. 이 엔드포인트의 새 버전은 입니다 문제 티켓 - PATCH /sn_ind_tsm_sdwan/ticket/troubleTicket/{id}.

URL 형식

기본 URL: /api/sn_ind_tsm_sdwan/troubleticket/{ticketType}/{id}

지원되는 요청 매개변수

표 25. 경로 매개변수

이름	설명
ticketType	티켓의 유형입니다. 이 값은 케이스 [sn_customerservice_case] 또는 인시던트 [incident] 테이블에서 기록이 업데이트되는지 여부를 결정합니다. 유효한 값은 다음과 같습니다. 케이스 인시던트 데이터 유형: 문자열
ID	업데이트할 케이스 또는 인시던트 기록의 Sys_id입니다. 데이터 유형: 문자열

표 26. 쿼리 매개변수

이름	설명
없음

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

이름	설명
채널	티켓이 생성된 연락 방법입니다. 데이터 유형: 객체 "channel":{ "name": "String" }
channel.name	연락 방법의 이름입니다. 케이스의 채널 [contact_type] 필드와 인시던트의 연락처 유형 [contact_type] 필드에 매핑합니다. 유효한 값은 contact_type 필드에 대한 선택 사항입니다. 선택 레이블 또는 값을 제공할 수 있습니다. 예를 들어 가상 에이전트 또는 virtual_agent입니다. 데이터 유형: 문자열
설명	문제에 대한 설명입니다. 설명 필드에 매핑합니다. 데이터 유형: 문자열
이름	문제 티켓의 이름으로, 일반적으로 문제에 대한 간단한 설명입니다. 간단한 설명 필드에 매핑합니다. 데이터 유형: 문자열
참고	티켓에 추가할 작업 메모 및 코멘트 목록입니다. 데이터 유형: 객체 배열 "note":[ { "text": "String", "@type": "String" } ]
note.@type	메모의 유형입니다. 이 값은 메모가 작업 메모 필드에 기록되는지 또는 추가 의견 필드에 기록되는지를 결정합니다. 유효한 값은 다음과 같습니다. 설명 work_notes 데이터 유형: 문자열
note.text	메모 텍스트. 작업 메모 또는 추가 의견 필드에 매핑합니다. 데이터 유형: 문자열
관련 엔터티	영향을 받는 자산, 제품, 판매된 제품(제품 인벤토리), 구성 항목 또는 서비스의 목록입니다. 데이터 유형: 객체 배열 "relatedEntity": [ { "id": "String", "@referredType": "String" } ]
relatedEntity.id	영향을 받는 항목 또는 서비스의 Sys_id입니다. 케이스의 경우 이 값은 다음 테이블 중 하나에서 가져옵니다. 자산 [alm_asset] 판매된 제품 [sn_install_base_sold_product] 테이블을 확장하는 제품 인벤토리 [sn_prd_invt_product_inventory] 제품 모델 [cmdb_model] 판매된 제품 [sn_install_base_sold_product] 인시던트의 경우 이 값은 다음 테이블 중 하나에서 가져옵니다. 구성 항목 [cmdb_ci] 서비스 [cmdb_ci_service] 데이터 유형: 문자열
relatedEntity.@referredType	항목 또는 서비스의 유형입니다. 케이스 티켓의 유효한 값: asset 제품 product_inventory 인시던트 티켓의 유효한 값: cmdb_ci cmdb_ci_service 데이터 유형: 문자열
관련당사자	티켓의 연락처에 대한 상세 정보입니다. 케이스의 경우 이 매개변수가 접촉 창구 또는 계정 필드를 채웁니다. 인시던트의 경우 이 매개변수는 호출자 또는 회사 필드를 채웁니다. 데이터 유형: 객체 배열 "relatedParty": [ { "id": "String", "@referredType": "String" } ]
relatedParty.@referredType	관련 당사자의 유형입니다. 유효한 값은 다음과 같습니다. 고객: 티켓의 회사 또는 계정입니다. customer_contact: 티켓의 발신자 또는 연락처입니다. 데이터 유형: 문자열
relatedParty.id	관련 당사자의 Sys_id입니다. 연락처나 사용자(호출자)를 제공하면 해당 계정이나 회사가 티켓에 자동으로 채워집니다. 데이터 유형: 문자열 테이블: 케이스의 경우 연락처[customer_contact] 또는 계정[customer_account] 테이블의 sys_id입니다. 인시던트의 경우 sys_id는 사용자 [sys_user] 또는 회사 [core_company] 테이블에서 가져옵니다.
severity	문제 티켓에서 설명하는 문제의 심각도입니다. 우선순위 필드를 매핑합니다. 유효한 값은 다음과 같습니다. 1: 중요 2: 높음 3: 보통 4: 낮음 5: 계획. 인시던트만. 우선순위 필드에 대해 선택하는 것이 유효한 값입니다. 선택 값만 제공해야 합니다. 예: 1. 잘못된 값이 제공되면 심각도가 낮음으로 설정됩니다. 데이터 유형: 문자열
상태	문제 티켓의 현재 상태입니다. 상태 필드에 매핑합니다. 유효한 값은 상태 필드에 대한 선택 사항입니다. 선택 레이블 또는 값을 제공할 수 있습니다. 예를 들어, 신규 또는 1입니다. 데이터 유형: 문자열

헤더

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

표 28. 요청 헤더

헤더	설명
수용	응답 본문의 데이터 형식입니다. application/json만 지원합니다.
컨텐츠-형식	요청 본문의 데이터 형식입니다. application/json만 지원합니다.

표 29. 응답 헤더

헤더	설명
없음

상태 코드

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

표 30. 상태 코드

상태 코드	설명
200	성공입니다. 요청이 성공적으로 처리되었습니다.
400	잘못된 요청입니다. 다음 중 하나 이상의 이유로 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다. 잘못된 경로 매개변수입니다. 잘못된 URI입니다.
404	기록 없음 ID와 관련된 기록을 케이스 [sn_customerservice_case] 또는 인시던트 [incident] 테이블에서 찾을 수 없습니다.

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

이름	설명
@type	이 값은 항상 TroubleTicket입니다. 데이터 유형: 문자열
채널	티켓이 생성된 연락 방법입니다. 데이터 유형: 객체 "channel":{ "name": "String" }
channel.name	연락 방법의 이름입니다. 데이터 유형: 문자열
creationDate	기록이 생성된 날짜입니다. 데이터 유형: 문자열
설명	티켓의 문제에 대한 설명입니다. 데이터 유형: 문자열
ID	케이스 또는 인시던트 기록의 sys_id입니다. 데이터 유형: 문자열
lastUpdate	기록이 마지막으로 업데이트된 날짜입니다. 데이터 유형: 문자열
이름	문제 티켓의 이름으로, 일반적으로 문제에 대한 간단한 설명입니다. 데이터 유형: 문자열
참고	티켓에 대한 모든 의견 목록입니다. 이 목록에는 작업 메모가 포함되어 있지 않습니다. 데이터 유형: 배열 "note":[ { "author": "String", "date": "String", "text": "String", "@type": "String" } ]
note.@type	메모의 유형입니다. 의견만 반환되므로(작업 메모 아님) 이 값은 항상 의견입니다. 데이터 유형: 문자열
메모.작성자	코멘트를 생성한 POST 또는 PATCH 요청을 수행한 ServiceNow 통합 사용자의 이름입니다. 데이터 유형: 문자열
note.date	ServiceNow 인스턴스에서 설명을 작성한 날짜입니다. 데이터 유형: 문자열
note.text	설명 텍스트입니다. 데이터 유형: 문자열
관련 엔터티	영향을 받는 자산, 제품, 판매된 제품(제품 인벤토리), 구성 항목 또는 서비스의 목록입니다. 데이터 유형: 객체 배열 "relatedEntity": [ { "id": "String", "href": "String", "name": "String", "role": "String", "@referredType": "String", "@type": "String" } ]
relatedEntity.id	영향을 받는 항목 또는 서비스의 Sys_id입니다. 케이스의 경우 이 값은 다음 테이블 중 하나에서 가져옵니다. 자산 [alm_asset] 판매된 제품 [sn_install_base_sold_product] 테이블을 확장하는 제품 인벤토리 [sn_prd_invt_product_inventory] 제품 모델 [cmdb_model] 판매된 제품 [sn_install_base_sold_product] 인시던트의 경우 이 값은 다음 테이블 중 하나에서 가져옵니다. 구성 항목 [cmdb_ci] 서비스 [cmdb_ci_service] 데이터 유형: 문자열
relatedEntity.href	빈 문자열을 반환합니다. 데이터 유형: 문자열
relatedEntity.name	영향을 받는 항목 또는 서비스의 이름입니다. 데이터 유형: 문자열
relatedEntity.role	영향을 받는 항목 또는 서비스에 대한 설명입니다. 데이터 유형: 문자열
relatedEntity.@referredType	항목 또는 서비스의 유형입니다. 케이스 티켓의 유효한 값: asset 제품 product_inventory 인시던트 티켓의 유효한 값: cmdb_ci cmdb_ci_service 데이터 유형: 문자열
relatedEntity.@type	이 값은 항상 relatedEntity입니다. 데이터 유형: 문자열
관련당사자	티켓과 연결된 회사 및 접촉 창구에 대한 상세 정보입니다. 데이터 유형: 배열 "relatedParty": [ { "id": "String", "name": "String", "@referredType": "String" } ]
relatedParty.@referredType	관련 당사자의 유형입니다. 유효한 값은 다음과 같습니다. 고객: 티켓의 회사 또는 계정입니다. customer_contact: 티켓의 발신자 또는 연락처입니다. 데이터 유형: 문자열
relatedParty.id	관련 당사자의 Sys_id입니다. 연락처나 사용자(호출자)를 제공하면 해당 계정이나 회사가 티켓에 자동으로 채워집니다. 데이터 유형: 문자열 테이블: 케이스의 경우 연락처[customer_contact] 또는 계정[customer_account] 테이블의 sys_id입니다. 인시던트의 경우 sys_id는 사용자 [sys_user] 또는 회사 [core_company] 테이블에서 가져옵니다.
relatedParty.name	관련 당사자의 이름입니다. 데이터 유형: 문자열
severity	문제 티켓에서 설명하는 문제의 심각도입니다. 데이터 유형: 문자열
상태	문제 티켓의 현재 상태입니다. 데이터 유형: 문자열
ticketType	티켓 유형(케이스 또는 인시던트)입니다. 데이터 유형: 문자열

cURL 요청

이 예에서는 케이스 기록을 업데이트합니다.

curl "https://instance.servicenow.com/api/sn_ind_tsm_sdwan/troubleticket/case/370415f03c20e910f8772f1bc332b31b" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
    \"description\":\"Router is not working, my devices cannot detect any signals from the router. First button from the left is flashing red, all others are black. Resetting the router does not solve the problem, I need urgent assistance.\",
    \"name\":\"My router is not working properly\",
    \"severity\":\"2\",
    \"status\":\"10\",
    \"ticketType\":\"Case\",
    \"channel\":{
        \"id\":\"8774\",
        \"name\":\"eBonding\",
        \"@type\":\"Channel\"
    },
    \"note\":[
        {
            \"id\":\"77456\",
            \"author\":\"Jack Smith\",
            \"date\":\"2019-05-31T07:34:45.968Z\",
            \"text\":\"This is a testing work note<html>hello world</html> and <h1>title</h1>\",
            \"@type\":\"Worknotes\"
        },
        {
            \"id\":\"77457\",
            \"author\":\"Jack Smith\",
            \"date\":\"2019-05-31T07:35:45.968Z\",
            \"text\":\"This is a testing comment<script>gs.info('Hello World')</script>\",
            \"@type\":\"Comment\"
        }
    ],
    \"relatedParty\":[
        {
            \"id\":\"eaf68911c35420105252716b7d40ddde\",
            \"href\":\"https://mycsp.com:8080/tmf-api/partyManagement/v1/individual/9866\",
            \"name\":\"Sally Thomas\",
            \"role\":\"customer\",
            \"@referredType\":\"customer_contact\"
        },
        {
            \"id\":\"ffc68911c35420105252716b7d40dd55\",
            \"href\":\"https://mycsp.com:8080/tmf-api/partyManagement/v4/customer/9176\",
            \"name\":\"Funco Intl\",
            \"role\":\"customer\",
            \"@referredType\":\"customer\"
        }
    ],
    \"relatedEntity\": [
        {
            \"id\": \"b7fa12c7532520103b6bddeeff7b123b\",
            \"href\": \"www.google.com\",
            \"name\": \"Some random name\",
            \"role\": \"I dont know what this is\",
            \"@type\": \"relatedEntity\",
            \"@referredType\": \"product\"
        },
        {
            \"id\": \"71e73d87c3e23010ff00ed23a140dde8\",
            \"href\": \"www.google.com\",
            \"name\": \"Some random name\",
            \"role\": \"I dont know what this is\",
            \"@type\": \"relatedEntity\",
            \"@referredType\": \"asset\"
        },
        {
            \"id\": \"a1913c3577b301108e191e599a5a99e8\",
            \"href\": \"www.google.com\",
            \"name\": \"Some random name\",
            \"role\": \"I dont know what this is\",
            \"@type\": \"relatedEntity\",
            \"@referredType\": \"product_inventory\"
        }
    ]
}" \
--user 'username':'password'

응답 본문.

{
  "id": "370415f03c20e910f8772f1bc332b31b",
  "href": "/api/sn_ind_tsm_sdwan/ticket/troubleTicket/370415f03c20e910f8772f1bc332b31b",
  "creationDate": "2023-01-19 22:39:28",
  "lastUpdate": "2023-01-19 22:41:39",
  "description": "Router is not working, my devices cannot detect any signals from the router. First button from the left is flashing red, all others are black. Resetting the router does not solve the problem, I need urgent assistance.",
  "severity": "2 - High",
  "ticketType": "Case",
  "name": "My router is not working properly",
  "status": "Open",
  "channel": {
    "name": "e_bonding"
  },
  "relatedParty": [
    {
      "id": "ffc68911c35420105252716b7d40dd55",
      "name": "Funco Intl",
      "@referredType": "customer"
    },
    {
      "id": "eaf68911c35420105252716b7d40ddde",
      "name": "Sally Thomas",
      "@referredType": "customer_contact"
    },
    {
      "id": "",
      "name": "",
      "@referredType": "assignment_group"
    },
    {
      "id": "",
      "name": "",
      "@referredType": "assigned_to"
    }
  ],
  "relatedEntity": [
    {
      "id": "b7fa12c7532520103b6bddeeff7b123b",
      "href": "",
      "name": "Deduplication and Compression PRD00001965",
      "role": "This is the product associated with the case.",
      "@type": "relatedEntity",
      "@referredType": "product"
    },
    {
      "id": "71e73d87c3e23010ff00ed23a140dde8",
      "href": "",
      "name": "",
      "role": "This is the asset associated with the case.",
      "@type": "relatedEntity",
      "@referredType": "asset"
    },
    {
      "id": "a1913c3577b301108e191e599a5a99e8",
      "href": "",
      "name": "Deduplication and Compression PI0000037",
      "role": "This is the product inventory associated with the case.",
      "@type": "relatedEntity",
      "@referredType": "product_inventory"
    }
  ],
  "note": [
    {
      "text": "This is a testing comment<script>gs.info('Hello World')</script>",
      "date": "2023-01-19 14:41:39",
      "author": "System Administrator",
      "@type": "comments"
    },
    {
      "text": "This is a testing comment<script>gs.info('Hello World')</script>",
      "date": "2023-01-19 14:39:28",
      "author": "System Administrator",
      "@type": "comments"
    }
  ],
  "@type": "TroubleTicket"
}

문제 티켓 - POST /sn_ind_tsm_sdwan/티켓/troubleTicket

케이스 [sn_customerservice_case] 또는 인시던트 [incident] 테이블에 기록을 작성합니다.

URL 형식

기본 URL: /api/sn_ind_tsm_sdwan/ticket/troubleTicket

지원되는 요청 매개변수

표 31. 경로 매개변수

이름	설명
없음

표 32. 쿼리 매개변수

이름	설명
없음

표 33. 요청 본문 매개변수(JSON)

이름	설명
채널	티켓이 생성된 연락 방법입니다. 데이터 유형: 객체 "channel":{ "name": "String" }
channel.name	연락 방법의 이름입니다. 케이스의 채널 [contact_type] 필드와 인시던트의 연락처 유형 [contact_type] 필드에 매핑합니다. 유효한 값은 contact_type 필드에 대한 선택 사항입니다. 선택 레이블 또는 값을 제공할 수 있습니다. 예를 들어 가상 에이전트 또는 virtual_agent입니다. 데이터 유형: 문자열
설명	필수 문제에 대한 설명입니다. 설명 필드에 매핑합니다. 데이터 유형: 문자열
이름	문제 티켓의 이름으로, 일반적으로 문제에 대한 간단한 설명입니다. 간단한 설명 필드에 매핑합니다. 데이터 유형: 문자열
참고	티켓에 추가할 작업 메모 및 코멘트 목록입니다. 데이터 유형: 객체 배열 "note":[ { "text": "String", "@type": "String" } ]
note.@type	메모의 유형입니다. 이 값은 메모가 작업 메모 필드에 기록되는지 또는 추가 의견 필드에 기록되는지를 결정합니다. 유효한 값은 다음과 같습니다. 설명 work_notes 데이터 유형: 문자열
note.text	메모 텍스트. 작업 메모 또는 추가 의견 필드에 매핑합니다. 데이터 유형: 문자열
관련 엔터티	영향을 받는 자산, 제품, 판매된 제품(제품 인벤토리), 구성 항목 또는 서비스의 목록입니다. 데이터 유형: 객체 배열 "relatedEntity": [ { "id": "String", "@referredType": "String" } ]
relatedEntity.id	영향을 받는 항목 또는 서비스의 Sys_id입니다. 케이스의 경우 이 값은 다음 테이블 중 하나에서 가져옵니다. 자산 [alm_asset] 판매된 제품 [sn_install_base_sold_product] 테이블을 확장하는 제품 인벤토리 [sn_prd_invt_product_inventory] 제품 모델 [cmdb_model] 판매된 제품 [sn_install_base_sold_product] 인시던트의 경우 이 값은 다음 테이블 중 하나에서 가져옵니다. 구성 항목 [cmdb_ci] 서비스 [cmdb_ci_service] 데이터 유형: 문자열
relatedEntity.@referredType	항목 또는 서비스의 유형입니다. 케이스 티켓의 유효한 값: asset 제품 product_inventory 인시던트 티켓의 유효한 값: cmdb_ci cmdb_ci_service 데이터 유형: 문자열
관련당사자	티켓의 연락처에 대한 상세 정보입니다. 케이스의 경우 이 매개변수가 접촉 창구 또는 계정 필드를 채웁니다. 인시던트의 경우 이 매개변수는 호출자 또는 회사 필드를 채웁니다. 데이터 유형: 객체 배열 "relatedParty": [ { "id": "String", "@referredType": "String" } ]
relatedParty.id	관련 당사자의 Sys_id입니다. 연락처나 사용자(호출자)를 제공하면 해당 계정이나 회사가 티켓에 자동으로 채워집니다. 데이터 유형: 문자열 테이블: 케이스의 경우 연락처[customer_contact] 또는 계정[customer_account] 테이블의 sys_id입니다. 인시던트의 경우 sys_id는 사용자 [sys_user] 또는 회사 [core_company] 테이블에서 가져옵니다.
relatedParty.@referredType	관련 당사자의 유형입니다. 유효한 값은 다음과 같습니다. 고객: 티켓의 회사 또는 계정입니다. customer_contact: 티켓의 발신자 또는 연락처입니다. 데이터 유형: 문자열
severity	필수 문제 티켓에서 설명하는 문제의 심각도입니다. 우선순위 필드를 매핑합니다. 유효한 값은 다음과 같습니다. 1: 중요 2: 높음 3: 보통 4: 낮음 5: 계획. 인시던트만. 우선순위 필드에 대해 선택하는 것이 유효한 값입니다. 선택 값만 제공해야 합니다. 예: 1. 잘못된 값이 제공되면 심각도가 낮음으로 설정됩니다. 데이터 유형: 문자열
상태	필수 문제 티켓의 현재 상태입니다. 상태 필드에 매핑합니다. 유효한 값은 상태 필드에 대한 선택 사항입니다. 선택 레이블 또는 값을 제공할 수 있습니다. 예를 들어, 신규 또는 1입니다. 잘못된 값을 입력하면 상태가 신규로 설정됩니다. 데이터 유형: 문자열
ticketType	티켓의 유형입니다. 이 값은 케이스 [sn_customerservice_case] 또는 인시던트 [incident] 테이블에 기록이 생성되는지 여부를 결정합니다. 유효한 값은 다음과 같습니다. 케이스 인시던트 데이터 유형: 문자열 기본값: Incident

헤더

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

표 34. 요청 헤더

헤더	설명
수용	응답 본문의 데이터 형식입니다. application/json만 지원합니다.
컨텐츠-형식	요청 본문의 데이터 형식입니다. application/json만 지원합니다.

표 35. 응답 헤더

헤더	설명
없음

상태 코드

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

표 36. 상태 코드

상태 코드	설명
201	성공입니다. 요청이 성공적으로 처리되었습니다.
400	잘못된 요청입니다. 다음 중 하나 이상의 이유로 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다. 빈 페이로드입니다. 잘못된 페이로드입니다. 필수 필드가 누락되었습니다. 잘못된 ticketType입니다.

응답 본문 매개변수(JSON)

이름	설명
@type	이 값은 항상 TroubleTicket입니다. 데이터 유형: 문자열
채널	티켓이 생성된 연락 방법입니다. 데이터 유형: 객체 "channel":{ "name": "String" }
channel.name	연락 방법의 이름입니다. 데이터 유형: 문자열
creationDate	케이스 또는 인시던트 기록이 생성된 날짜입니다. 데이터 유형: 문자열
설명	티켓의 문제에 대한 설명입니다. 데이터 유형: 문자열
href	케이스 또는 인시던트 기록에 대한 상대 링크입니다. 데이터 유형: 문자열
ID	생성된 케이스 또는 인시던트 기록의 sys_id입니다. 데이터 유형: 문자열
lastUpdate	케이스 또는 인시던트 기록이 마지막으로 업데이트된 날짜입니다. 데이터 유형: 문자열
이름	문제 티켓의 이름으로, 일반적으로 문제에 대한 간단한 설명입니다. 데이터 유형: 문자열
참고	티켓에 대한 모든 의견 목록입니다. 이 목록에는 작업 메모가 포함되어 있지 않습니다. 데이터 유형: 배열 "note":[ { "author": "String", "date": "String", "text": "String", "@type": "String" } ]
note.@type	메모의 유형입니다. 의견만 반환되므로(작업 메모 아님) 이 값은 항상 의견입니다. 데이터 유형: 문자열
메모.작성자	코멘트를 작성한 사용자의 이름입니다. 데이터 유형: 문자열
note.date	인스턴스에서 설명이 생성된 ServiceNow 날짜입니다. 데이터 유형: 문자열
note.text	설명 텍스트입니다. 데이터 유형: 문자열
관련 엔터티	영향을 받는 자산, 제품, 판매된 제품(제품 인벤토리), 구성 항목 또는 서비스의 목록입니다. 데이터 유형: 객체 배열 "relatedEntity": [ { "id": "String", "href": "String", "name": "String", "role": "String", "@referredType": "String", "@type": "String" } ]
relatedEntity.id	영향을 받는 항목 또는 서비스의 Sys_id입니다. 케이스의 경우 이 값은 다음 테이블 중 하나에서 가져옵니다. 자산 [alm_asset] 판매된 제품 [sn_install_base_sold_product] 테이블을 확장하는 제품 인벤토리 [sn_prd_invt_product_inventory] 제품 모델 [cmdb_model] 판매된 제품 [sn_install_base_sold_product] 인시던트의 경우 이 값은 다음 테이블 중 하나에서 가져옵니다. 구성 항목 [cmdb_ci] 서비스 [cmdb_ci_service] 데이터 유형: 문자열
relatedEntity.href	빈 문자열을 반환합니다. 데이터 유형: 문자열
relatedEntity.name	영향을 받는 항목 또는 서비스의 이름입니다. 데이터 유형: 문자열
relatedEntity.role	영향을 받는 항목 또는 서비스에 대한 설명입니다. 데이터 유형: 문자열
relatedEntity.@referredType	항목 또는 서비스의 유형입니다. 케이스 티켓의 유효한 값: asset 제품 product_inventory 인시던트 티켓의 유효한 값: cmdb_ci cmdb_ci_service 데이터 유형: 문자열
relatedEntity.@type	이 값은 항상 relatedEntity입니다. 데이터 유형: 문자열
관련당사자	티켓의 연락처에 대한 상세 정보입니다. 데이터 유형: 객체 배열 "relatedParty": [ { "id": "String", "name": "String", "@referredType": "String" } ]
relatedParty.id	관련 당사자의 Sys_id입니다. 티켓 유형 및 관련 당사자 유형에 따라 다음 테이블에서 sys_id 수 있습니다. 케이스: 계정 [customer_account]; 관련 공급업체 유형은 고객임 연락처 [customer_contact]; 관련 공급업체 유형이 customer_contact 인시던트: 회사 [core_company]; 관련 공급업체 유형은 고객임 사용자 [sys_user]; 관련 공급업체 유형이 customer_contact 케이스 또는 인시던트: 그룹 [sys_user_group]; 관련 공급업체 유형이 assignment_group 사용자 [sys_user]; 관련 공급업체 유형이 assigned_to 데이터 유형: 문자열
relatedParty.name	관련 당사자의 이름입니다. 데이터 유형: 문자열
relatedParty.@referredType	관련 당사자의 유형입니다. 가능한 값: assigned_to: 티켓에서 작업에 할당된 사용자입니다. assignment_group: 티켓에서 작업에 할당된 그룹입니다. 고객: 티켓의 회사 또는 계정입니다. customer_contact: 티켓의 발신자 또는 연락처입니다. 데이터 유형: 문자열
severity	문제 티켓에서 설명하는 문제의 심각도입니다. 데이터 유형: 문자열
상태	문제 티켓의 현재 상태입니다. 데이터 유형: 문자열
ticketType	티켓의 유형입니다. 가능한 값: 케이스 인시던트 데이터 유형: 문자열

cURL 요청

이 예에서는 문제 티켓 케이스 기록을 생성합니다.

curl "https://instance.servicenow.com/api/sn_ind_tsm_sdwan/ticket/troubleTicket" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
   "name": "Laptop problem",
   "description": "Laptop keeps shutting off unexpectedly",
   "severity": "2",
   "status": "New",
   "ticketType": "Case",
   "channel": {
      "name": "Web"
   },
   "note": [
      {
         "text": "Work note about this case",
         "@type": "work_notes"
      },
      {
         "text": "Comment about this case",
         "@type": "comments"
      }
   ],
   "relatedEntity": [
      {
         "id": "74a9ec0d3790200044e0bfc8bcbe5d7f",
         "@referredType": "asset"
      }
   ],
   "relatedParty": [
      {
         "id": "62826bf03710200044e0bfc8bcbe5df1",
         "@referredType": "customer_contact"
      }
   ]
}" \
--user 'username':'password'

응답 본문.

{
   "id": "6467508d47e345508761b955d36d43f6",
   "href": "/api/sn_ind_tsm_sdwan/ticket/troubleTicket/6467508d47e345508761b955d36d43f6",
   "creationDate": "2022-05-16 23:38:55",
   "lastUpdate": "2022-05-16 23:38:55",
   "description": "Laptop keeps shutting off unexpectedly",
   "severity": "2 - High",
   "ticketType": "Case",
   "name": "Laptop problem",
   "status": "New",
   "channel": {
      "name": "web"
   },
   "relatedParty": [
      {
         "id": "",
         "name": "",
         "@referredType": "customer"
      },
      {
         "id": "62826bf03710200044e0bfc8bcbe5df1",
         "name": "",
         "@referredType": "customer_contact"
      },
      {
         "id": "",
         "name": "",
         "@referredType": "assignment_group"
      },
      {
         "id": "",
         "name": "",
         "@referredType": "assigned_to"
      }
   ],
   "relatedEntity": [
      {
         "id": "",
         "href": "",
         "name": "",
         "role": "This is the product associated with the case.",
         "@type": "relatedEntity",
         "@referredType": "product"
      },
      {
         "id": "74a9ec0d3790200044e0bfc8bcbe5d7f",
         "href": "",
         "name": "P1000597 - Apple MacBook Pro 15\"",
         "role": "This is the asset associated with the case.",
         "@type": "relatedEntity",
         "@referredType": "asset"
      }
      {
         "id": "a1913c3577b301108e191e599a5a99e8",
         "href": "",
         "name": "Deduplication and Compression PI0000037",
         "role": "This is the product inventory associated with the case.",
         "@type": "relatedEntity",
         "@referredType": "product_inventory"
      }
   ],
   "note": [
      {
         "text": "Comment about this case",
         "date": "2022-05-16 16:38:55",
         "author": "admin",
         "@type": "comments"
      }
   ],
   "@type": "TroubleTicket"
}

문제 티켓 - POST /sn_ind_tsm_sdwan/troubleticket/{ticketType}

케이스 [sn_customerservice_case] 또는 인시던트 [incident] 테이블에 기록을 작성합니다.

중요사항:

릴리스부터 Tokyo 이 엔드포인트는 더 이상 사용되지 않습니다. 이 엔드포인트의 새 버전은 입니다 문제 티켓 - POST /sn_ind_tsm_sdwan/티켓/troubleTicket.

URL 형식

기본 URL: /api/sn_ind_tsm_sdwan/troubleticket/{ticketType}

지원되는 요청 매개변수

표 37. 경로 매개변수

이름	설명
ticketType	티켓의 유형입니다. 이 값은 케이스 [sn_customerservice_case] 또는 인시던트 [incident] 테이블에 기록이 생성되는지 여부를 결정합니다. 유효한 값은 다음과 같습니다. 케이스 인시던트 데이터 유형: 문자열

표 38. 쿼리 매개변수

이름	설명
없음

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

이름	설명
채널	티켓이 생성된 연락 방법입니다. 데이터 유형: 객체 "channel":{ "name": "String" }
channel.name	연락 방법의 이름입니다. 케이스의 채널 [contact_type] 필드와 인시던트의 연락처 유형 [contact_type] 필드에 매핑합니다. 유효한 값은 contact_type 필드에 대한 선택 사항입니다. 선택 레이블 또는 값을 제공할 수 있습니다. 예를 들어 가상 에이전트 또는 virtual_agent입니다. 데이터 유형: 문자열
설명	필수 문제에 대한 설명입니다. 설명 필드에 매핑합니다. 데이터 유형: 문자열
이름	문제 티켓의 이름으로, 일반적으로 문제에 대한 간단한 설명입니다. 간단한 설명 필드에 매핑합니다. 데이터 유형: 문자열
참고	티켓에 추가할 작업 메모 및 코멘트 목록입니다. 데이터 유형: 객체 배열 "note":[ { "text": "String", "@type": "String" } ]
note.@type	메모의 유형입니다. 이 값은 메모가 작업 메모 필드에 기록되는지 또는 추가 의견 필드에 기록되는지를 결정합니다. 유효한 값은 다음과 같습니다. 설명 work_notes 데이터 유형: 문자열
note.text	메모 텍스트. 작업 메모 또는 추가 의견 필드에 매핑합니다. 데이터 유형: 문자열
관련 엔터티	영향을 받는 자산, 제품, 판매된 제품(제품 인벤토리), 구성 항목 또는 서비스의 목록입니다. 데이터 유형: 객체 배열 "relatedEntity": [ { "id": "String", "@referredType": "String" } ]
relatedEntity.id	영향을 받는 항목 또는 서비스의 Sys_id입니다. 케이스의 경우 이 값은 다음 테이블 중 하나에서 가져옵니다. 자산 [alm_asset] 판매된 제품 [sn_install_base_sold_product] 테이블을 확장하는 제품 인벤토리 [sn_prd_invt_product_inventory] 제품 모델 [cmdb_model] 판매된 제품 [sn_install_base_sold_product] 인시던트의 경우 이 값은 다음 테이블 중 하나에서 가져옵니다. 구성 항목 [cmdb_ci] 서비스 [cmdb_ci_service] 데이터 유형: 문자열
relatedEntity.@referredType	항목 또는 서비스의 유형입니다. 케이스 티켓의 유효한 값: asset 제품 product_inventory 인시던트 티켓의 유효한 값: cmdb_ci cmdb_ci_service 데이터 유형: 문자열
관련당사자	티켓의 연락처에 대한 상세 정보입니다. 케이스의 경우 이 매개변수가 접촉 창구 또는 계정 필드를 채웁니다. 인시던트의 경우 이 매개변수는 호출자 또는 회사 필드를 채웁니다. 데이터 유형: 객체 배열 "relatedParty": [ { "id": "String", "@referredType": "String" } ]
relatedParty.@referredType	관련 당사자의 유형입니다. 유효한 값은 다음과 같습니다. 고객: 티켓의 회사 또는 계정입니다. customer_contact: 티켓의 발신자 또는 연락처입니다. 데이터 유형: 문자열
relatedParty.id	관련 당사자의 Sys_id입니다. 연락처나 사용자(호출자)를 제공하면 해당 계정이나 회사가 티켓에 자동으로 채워집니다. 데이터 유형: 문자열 테이블: 케이스의 경우 연락처[customer_contact] 또는 계정[customer_account] 테이블의 sys_id입니다. 인시던트의 경우 sys_id는 사용자 [sys_user] 또는 회사 [core_company] 테이블에서 가져옵니다.
severity	필수 문제 티켓에서 설명하는 문제의 심각도입니다. 우선순위 필드를 매핑합니다. 유효한 값은 다음과 같습니다. 1: 중요 2: 높음 3: 보통 4: 낮음 5: 계획. 인시던트만. 우선순위 필드에 대해 선택하는 것이 유효한 값입니다. 선택 값만 제공해야 합니다. 예: 1. 잘못된 값이 제공되면 심각도가 낮음으로 설정됩니다. 데이터 유형: 문자열
상태	문제 티켓의 현재 상태입니다. 상태 필드에 매핑합니다. 유효한 값은 상태 필드에 대한 선택 사항입니다. 선택 레이블 또는 값을 제공할 수 있습니다. 예를 들어, 신규 또는 1입니다. 데이터 유형: 문자열 기본값: 신규
ticketType	필수 티켓의 유형입니다. 이 값은 케이스 [sn_customerservice_case] 또는 인시던트 [incident] 테이블에 기록이 생성되는지 여부를 결정합니다. 유효한 값은 다음과 같습니다. 케이스 인시던트 데이터 유형: 문자열

헤더

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

표 40. 요청 헤더

헤더	설명
수용	응답 본문의 데이터 형식입니다. application/json만 지원합니다.
컨텐츠-형식	요청 본문의 데이터 형식입니다. application/json만 지원합니다.

표 41. 응답 헤더

헤더	설명
없음

상태 코드

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

표 42. 상태 코드

상태 코드	설명
201	성공입니다. 요청이 성공적으로 처리되었습니다.
400	잘못된 요청입니다. 다음 중 하나 이상의 이유로 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다. 빈 페이로드입니다. 잘못된 페이로드입니다. 필수 필드가 누락되었습니다. 잘못된 ticketType 또는 ticketType이 경로 매개변수 ticketType과 일치하지 않습니다. 예를 들어 ticketType은 case 이지만 path 매개 변수는 incident입니다.

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

이름	설명
@type	이 값은 항상 TroubleTicket입니다. 데이터 유형: 문자열
채널	티켓이 생성된 연락 방법입니다. 데이터 유형: 객체 "channel":{ "name": "String" }
channel.name	연락 방법의 이름입니다. 데이터 유형: 문자열
creationDate	케이스 또는 인시던트 기록이 생성된 날짜입니다. 데이터 유형: 문자열
설명	티켓의 문제에 대한 설명입니다. 데이터 유형: 문자열
ID	생성된 케이스 또는 인시던트 기록의 Sys_id입니다. 데이터 유형: 문자열
lastUpdate	케이스 또는 인시던트 기록이 마지막으로 업데이트된 날짜입니다. 데이터 유형: 문자열
이름	문제 티켓의 이름으로, 일반적으로 문제에 대한 간단한 설명입니다. 데이터 유형: 문자열
참고	POST 요청에 의해 티켓에 추가된 코멘트 및 작업 메모 목록입니다. 데이터 유형: 객체 배열 "note":[ { "author": "String", "date": "String", "text": "String", "@type": "String" } ]
note.@type	메모의 유형입니다. 유효한 값은 다음과 같습니다. 설명 work_notes 데이터 유형: 문자열
메모.작성자	ServiceNow 메모를 작성한 POST 요청을 한 통합 사용자의 이름입니다. 데이터 유형: 문자열
note.date	인스턴스에서 메모가 ServiceNow 생성된 날짜입니다. 데이터 유형: 문자열
note.text	메모 텍스트. 데이터 유형: 문자열
관련 엔터티	영향을 받는 자산, 제품, 판매된 제품(제품 인벤토리), 구성 항목 또는 서비스의 목록입니다. 데이터 유형: 객체 배열 "relatedEntity": [ { "id": "String", "href": "String", "name": "String", "role": "String", "@referredType": "String", "@type": "String" } ]
relatedEntity.id	영향을 받는 항목 또는 서비스의 Sys_id입니다. 케이스의 경우 이 값은 다음 테이블 중 하나에서 가져옵니다. 자산 [alm_asset] 판매된 제품 [sn_install_base_sold_product] 테이블을 확장하는 제품 인벤토리 [sn_prd_invt_product_inventory] 제품 모델 [cmdb_model] 판매된 제품 [sn_install_base_sold_product] 인시던트의 경우 이 값은 다음 테이블 중 하나에서 가져옵니다. 구성 항목 [cmdb_ci] 서비스 [cmdb_ci_service] 데이터 유형: 문자열
relatedEntity.href	빈 문자열을 반환합니다. 데이터 유형: 문자열
relatedEntity.name	영향을 받는 항목 또는 서비스의 이름입니다. 데이터 유형: 문자열
relatedEntity.role	영향을 받는 항목 또는 서비스에 대한 설명입니다. 데이터 유형: 문자열
relatedEntity.@referredType	항목 또는 서비스의 유형입니다. 케이스 티켓의 유효한 값: asset 제품 product_inventory 인시던트 티켓의 유효한 값: cmdb_ci cmdb_ci_service 데이터 유형: 문자열
relatedEntity.@type	이 값은 항상 relatedEntity입니다. 데이터 유형: 문자열
관련당사자	티켓과 연결된 회사 및 접촉 창구에 대한 상세 정보입니다. 데이터 유형: 객체 배열 "relatedParty": [ { "id": "String", "@referredType": "String" } ]
relatedParty.id	관련 당사자의 Sys_id입니다. 연락처나 사용자(호출자)를 제공하면 해당 계정이나 회사가 티켓에 자동으로 채워집니다. 데이터 유형: 문자열 테이블: 케이스의 경우 연락처[customer_contact] 또는 계정[customer_account] 테이블의 sys_id입니다. 인시던트의 경우 sys_id는 사용자 [sys_user] 또는 회사 [core_company] 테이블에서 가져옵니다.
relatedParty.referredType	관련 당사자의 유형입니다. 유효한 값은 다음과 같습니다. 고객: 티켓의 회사 또는 계정입니다. customer_contact: 티켓의 발신자 또는 연락처입니다. 데이터 유형: 문자열
severity	문제 티켓에서 설명하는 문제의 심각도입니다. 데이터 유형: 문자열
상태	문제 티켓의 현재 상태입니다. 데이터 유형: 문자열
ticketType	티켓의 유형(케이스 또는 인시던트)입니다. 데이터 유형: 문자열

cURL 요청

이 예에서는 우선순위가 높고 오픈 상태의 케이스를 만듭니다.

ccurl "https://instance.servicenow.com/api/sn_ind_tsm_sdwan/troubleticket/case" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
    \"description\":\"Router is not working, my devices cannot detect any signals from the router. First button from the left is flashing red, all others are black. Resetting the router does not solve the problem, I need urgent assistance.\",
    \"name\":\"My router is not working properly\",
    \"severity\":\"2\",
    \"status\":\"10\",
    \"ticketType\":\"Case\",
    \"channel\":{
        \"id\":\"8774\",
        \"name\":\"eBonding\",
        \"@type\":\"Channel\"
    },
    \"note\":[
        {
            \"id\":\"77456\",
            \"author\":\"Jack Smith\",
            \"date\":\"2019-05-31T07:34:45.968Z\",
            \"text\":\"This is a testing work note<html>hello world</html> and <h1>title</h1>\",
            \"@type\":\"Worknotes\"
        },
        {
            \"id\":\"77457\",
            \"author\":\"Jack Smith\",
            \"date\":\"2019-05-31T07:35:45.968Z\",
            \"text\":\"This is a testing comment<script>gs.info('Hello World')</script>\",
            \"@type\":\"Comment\"
        }
    ],
    \"relatedParty\":[
        {
            \"id\":\"eaf68911c35420105252716b7d40ddde\",
            \"href\":\"https://mycsp.com:8080/tmf-api/partyManagement/v1/individual/9866\",
            \"name\":\"Sally Thomas\",
            \"role\":\"customer\",
            \"@referredType\":\"customer_contact\"
        },
        {
            \"id\":\"ffc68911c35420105252716b7d40dd55\",
            \"href\":\"https://mycsp.com:8080/tmf-api/partyManagement/v4/customer/9176\",
            \"name\":\"Funco Intl\",
            \"role\":\"customer\",
            \"@referredType\":\"customer\"
        }
    ],
    \"relatedEntity\": [
        {
            \"id\": \"b7fa12c7532520103b6bddeeff7b123b\",
            \"href\": \"www.google.com\",
            \"name\": \"Some random name\",
            \"role\": \"I dont know what this is\",
            \"@type\": \"relatedEntity\",
            \"@referredType\": \"product\"
        },
        {
            \"id\": \"71e73d87c3e23010ff00ed23a140dde8\",
            \"href\": \"www.google.com\",
            \"name\": \"Some random name\",
            \"role\": \"I dont know what this is\",
            \"@type\": \"relatedEntity\",
            \"@referredType\": \"asset\"
        },
        {
            \"id\": \"a1913c3577b301108e191e599a5a99e8\",
            \"href\": \"www.google.com\",
            \"name\": \"Some random name\",
            \"role\": \"I dont know what this is\",
            \"@type\": \"relatedEntity\",
            \"@referredType\": \"product_inventory\"
        }
    ]
}" \
--user 'username':'password'

응답 본문.

{
  "id": "5bbb5cbc3c2ca910f8772f1bc332b34d",
  "href": "/api/sn_ind_tsm_sdwan/ticket/troubleTicket/5bbb5cbc3c2ca910f8772f1bc332b34d",
  "creationDate": "2023-01-19 18:33:24",
  "lastUpdate": "2023-01-19 18:33:24",
  "description": "Router is not working, my devices cannot detect any signals from the router. First button from the left is flashing red, all others are black. Resetting the router does not solve the problem, I need urgent assistance.",
  "severity": "2 - High",
  "ticketType": "Case",
  "name": "My router is not working properly",
  "status": "Open",
  "channel": {
    "name": "e_bonding"
  },
  "relatedParty": [
    {
      "id": "ffc68911c35420105252716b7d40dd55",
      "name": "Funco Intl",
      "@referredType": "customer"
    },
    {
      "id": "eaf68911c35420105252716b7d40ddde",
      "name": "Sally Thomas",
      "@referredType": "customer_contact"
    },
    {
      "id": "",
      "name": "",
      "@referredType": "assignment_group"
    },
    {
      "id": "",
      "name": "",
      "@referredType": "assigned_to"
    }
  ],
  "relatedEntity": [
    {
      "id": "b7fa12c7532520103b6bddeeff7b123b",
      "href": "",
      "name": "Deduplication and Compression PRD00001965",
      "role": "This is the product associated with the case.",
      "@type": "relatedEntity",
      "@referredType": "product"
    },
    {
      "id": "71e73d87c3e23010ff00ed23a140dde8",
      "href": "",
      "name": "",
      "role": "This is the asset associated with the case.",
      "@type": "relatedEntity",
      "@referredType": "asset"
    },
    {
      "id": "a1913c3577b301108e191e599a5a99e8",
      "href": "",
      "name": "Deduplication and Compression PI0000037",
      "role": "This is the product inventory associated with the case.",
      "@type": "relatedEntity",
      "@referredType": "product_inventory"
    }
  ],
  "note": [
    {
      "text": "This is a testing comment<script>gs.info('Hello World')</script>",
      "date": "2023-01-19 10:33:24",
      "author": "System Administrator",
      "@type": "comments"
    }
  ],
  "@type": "TroubleTicket"
}