---
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) 소요 시간: 25분

원격 지원 요청 API는 전자 의료 기록(EMR) 시스템에서 IT 서비스 요청 및 세부 정보 목록을 생성, 보고 가져올 수 있는 엔드포인트를 제공합니다. IT 서비스 요청은 인스턴스의 ServiceNow 인시던트와 같은 작업 유형과 연결됩니다.
이 API는 다음과 같은 경우에만 사용할 수 있습니다. [EMR 지원](https://www.servicenow.com/docs/access?context=emr-help&version=xanadu&pubname=xanadu-healthcare-life-sciences&ft:locale=en-US) 애플리케이션(sn_ind_rmt_help)은 ServiceNow Store. [ServiceNow Store](https://store.servicenow.com/sn_appstore_store.do#!/store/home) 웹 사이트를 방문하면 사용 가능한 모든 앱을 확인하고 스토어에 요청을 제출하는 방법에 대한 정보를 참조할 수 있습니다. 출시된 모든 앱의 누적 릴리스 정보는 [ServiceNow Store 버전 기록 릴리스 정보](https://www.servicenow.com/docs/bundle/store-release-notes/page/release-notes/store/sn-store-release-notes.html)를 참조하십시오.

이 API의 엔드포인트에 액세스하는 데 필요한 역할: sn_ind_rmt_help.requester.

## 원격 도움말 요청 - POST /remote_help_request/{req_defn_id} {#ariaid-title2}

EMR(전자 의료 기록) 시스템 데이터를 해당 ServiceNow 테이블에 삽입합니다.
작업에 대한 파라미터 및 작업과 연결된 요청 데이터 테이블에 유지되는 EMR 시스템의 추가 데이터 외에도 [요청 정의 ID](https://www.servicenow.com/docs/access?context=configure-emr-help-req-def&version=xanadu&pubname=xanadu-healthcare-life-sciences&ft:locale=en-US)를 지정해야 합니다. 이 엔드포인트에는 두 가지 유형의 데이터가 전달됩니다. 첫 번째는 엔드포인트가 원격 요청 데이터 \[sn_ind_rmt_help_request_data\] 테이블 및 연결된 자식 테이블에 삽입하는 요청 데이터입니다. 두 번째는 엔드포인트가 원격 요청 매개 변수 \[sn_ind_rmt_help_request_param\] 테이블에 삽입하는 IT 서비스 요청의 작업 매개 변수입니다. [요청 정의](https://www.servicenow.com/docs/access?context=configure-emr-help-req-def&version=xanadu&pubname=xanadu-healthcare-life-sciences&ft:locale=en-US)에 정의된 데이터 또는 필드만 엔드포인트에서 처리됩니다. 이 데이터 모델에 대한 자세한 내용은 [EMR 도움말 데이터 모델](https://www.servicenow.com/docs/access?context=emr-data-model&version=xanadu&pubname=xanadu-healthcare-life-sciences&ft:locale=en-US) 섹션을 참조하세요.

기록은 요청 정의 ID를 사용하여 식별됩니다.

### URL 형식

버전이 지정된 URL: /api/sn_ind_rmt_help/{api_version}/remote_help_request/{req_defn_id}

기본 URL: /api/sn_ind_rmt_help/remote_help_request/{req_defn_id}

### 지원되는 요청 매개변수

{#remote_help_request-POST__entry__2}{#remote_help_request-POST__version-RESTAPI}

| 이름 | 설명 |
|-|-|
| api_version | 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 <kbd class="ph userinput">v1</kbd> 또는 <kbd class="ph userinput">v2</kbd>입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열 |
| req_defn_id | 요청 정의의 고유 ID입니다. 이 값은 원격 요청 정의 \[sn_ind_rmt_help_request_defn\] 테이블의 ID 열에 해당합니다. 데이터 유형: 문자열 |
[표 1. 경로 매개변수]

{#remote_help_request-POST__entry__8}

| 이름 | 설명 |
|-|-|
| 없음 |   |
[표 2. 쿼리 매개변수]

{#remote_help_request-POST__entry__12}

| 이름 | 설명 |
|-|-|
| request_data | 필수 원격 요청 데이터 \[sn_ind_rmt_help_request_data\] 테이블과 해당 하위 테이블에 추가할 EMR 시스템 요청 데이터의 이름-값 쌍입니다. 예: "request_data":{ "additional_info": "String", "application": "String", "environment": "String", "issue_type": "String", "millennium_username": "String", "position": "String", "server": "String", "session_recording_id": "String", "user_is_physician": "String", "work_station": "String" } 주: 객체의 요청 정의에 구성된 매개변수만 request_data 전달합니다. 다른 매개변수는 무시됩니다. 자세한 내용은 [EMR 시스템에 대한 요청 정의 구성을](https://www.servicenow.com/docs/access?context=configure-emr-help-req-def&version=xanadu&pubname=xanadu-healthcare-life-sciences&ft:locale=en-US) 참조하세요. 데이터 유형: 객체 |
| 소스 | 필수 요청 정의에 지정된 대로 엔드포인트를 호출하는 EMR 시스템의 이름입니다. 예: "source":"Cerner" 데이터 유형: 문자열 |
| task_parameters | 필수 IT 서비스 요청의 작업 매개변수를 설명하는 이름-값 쌍입니다. 객체의 각 요소는 인시던트 \[incident\] 테이블과 같은 해당 작업 테이블의 열에 해당됩니다. 예: "task_parameters": { "caller_id": "String", "contact_type": "String", "impact": "String", "short_description": "String" } 주: 객체의 요청 정의에 구성된 매개변수만 task_parameters 전달합니다. 다른 매개변수는 무시됩니다. 자세한 내용은 [EMR 시스템에 대한 요청 정의 구성을](https://www.servicenow.com/docs/access?context=configure-emr-help-req-def&version=xanadu&pubname=xanadu-healthcare-life-sciences&ft:locale=en-US) 참조하세요. 데이터 유형: 객체 |
[표 3. 요청 본문 매개변수(JSON)]

### 헤더

다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 [지원되는 REST API 헤더를](https://servicenow-prod.fluidtopics.net/JHL64oGR2SkU25ZTkfHy7g "REST(REpresentational State Transfer)는 웹상의 컴퓨터 시스템 간에 표준을 제공하여 서로 보다 쉽게 통신할 수 있게 지원하는 단순한 상태 비저장 아키텍처입니다.") 참조하세요.
{#remote_help_request-POST__table_wvv_2yf_snb__entry__2}{#remote_help_request-POST__accept-JSON-only-entry-RESTAPI}{#remote_help_request-POST__content_type-JSON-only-entry-RESTAPI}

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

{#remote_help_request-POST__table_wvv_2yf_snb} {#remote_help_request-POST__entry__26}

| 헤더 | 설명 |
|-|-|
| 없음 |   |
[표 5. 응답 헤더]

### 상태 코드

다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 [REST API HTTP 응답 코드를](https://servicenow-prod.fluidtopics.net/JHL64oGR2SkU25ZTkfHy7g "REST(REpresentational State Transfer)는 웹상의 컴퓨터 시스템 간에 표준을 제공하여 서로 보다 쉽게 통신할 수 있게 지원하는 단순한 상태 비저장 아키텍처입니다.") 참조하세요.
{#remote_help_request-POST__entry__30}{#remote_help_request-POST__entry-200-status-code}{#remote_help_request-POST__entry-401-status-code}{#remote_help_request-POST__entry-500-status-code}

| 상태 코드 | 설명 |
|-|-|
| 200 | 성공입니다. 요청이 성공적으로 처리되었습니다. |
| 401 | 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다. |
| 500 | 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다. |
[표 6. 상태 코드]

### 응답 본문 매개변수(JSON)

{#remote_help_request-POST__entry__38}

| 이름 | 설명 |
|-|-|
| 결과 | 결과 객체입니다. "result": { "code": "String", "error": "String", "errorTranslated": "String", "status": "String", "task_id": "String", "task_table": "String", "warning": "String", "warningTranslated": "String" } 데이터 유형: 객체 |
| 결과.코드 | 가 실패로 반환될 경우 result.status 의 애플리케이션 오류 코드입니다. 데이터 유형: 문자열 |
| 결과.오류 | 실패인 경우 result.status 포함되는 오류 메시지입니다. 이 메시지는 영어로만 작성됩니다. 데이터 유형: 문자열 |
| result.errorTranslated | 지역화된 오류 메시지(선택 사항)입니다. 데이터 유형: 문자열 |
| 결과.상태 | 응답 상태입니다. 유효한 값은 다음과 같습니다. * 성공 * 실패 {#remote_help_request-POST__ul_awy_1dk_snb} 데이터 유형: 문자열 |
| result.task_id | 생성된 작업의 Sys_id입니다. 데이터 유형: 문자열 |
| result.task_table | 요청 정의에 정의된 대로 작업이 생성된 작업 테이블의 이름입니다. 데이터 유형: 문자열 |
| 결과.경고 | 선택적 경고 메시지입니다. 성공할 경우 result.status 포함될 수 있습니다. 이 메시지는 영어로만 작성됩니다. 데이터 유형: 문자열 |
| result.warning번역됨 | 지역화된 경고 메시지(선택 사항)입니다. 데이터 유형: 문자열 |
[ ]

### cURL 요청

Cerner EMR 시스템에서 데이터를 삽입합니다.

    curl "https://instance.servicenow.com/api/sn_ind_rmt_help/v1/remote_help_request/sn_it_request" 
    --request POST \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --data "{
      "source":"Cerner",
      "task_parameters":{
        "short_description":"Unable to load patient data",
        "caller_id":"82d4ecb4db40e8100e28aa594b96195c",
        "impact":"2",
        "contact_type":"email"
      },
      "request_data":{
        "application":"Powerchart",
        "server":"CTXCHSITN453",
        "environment":"CTX24",
        "issue_type":"Helpdesk",
        "millennium_username":"JOHN JASON",
        "position":"Lab Tech",
        "session_recording_id":"s5ds34dd96491b959a35010651896k",
        "user_is_physician":"Yes",
        "work_station":"PC354FLR3STATION7",
        "additional_info":"MRN 222333"    
      }
    }" \
    --user "username":"password"

다음 출력은 성공 응답과 오류 응답을 모두 보여줍니다.

    // Successful response
    {
      "result": {
        "task_id": "75b09061db2cac100e28aa594b9619fa",
        "status": "success",
        "task_table": "incident",
        "warning": "Ignored invalid fields on table incident : test1",
        "warningTranslated": "Ignored invalid fields on table incident : test1"
      }
    }

    // Error response
    {  
          "result": {
          "status": "failure",
          "code": "1001",
          "error": "Invalid request definition: test_request1",
          "errorTranslated": "Invalid request definition: test_request1"
          }
          }

## 원격 도움말 요청 - PUT /remote_help_request/{req_defn_id/task/{task_id} {#ariaid-title3}

작업에 대해 지정된 원격 요청 데이터 테이블의 기록을 업데이트합니다.
작업 sys_id 외에 요청 정의 ID를 지정하여 이전에 생성된 원격 요청을 업데이트할 수 있습니다.

### URL 형식

버전이 지정된 URL: /api/sn_ind_rmt_help/{api_version}/remote_help_request/{req_defn_id/task/{task_id}

기본 URL: /api/sn_ind_rmt_help/remote_help_request/{req_defn_id/task/{task_id}

### 지원되는 요청 매개변수

{#remote_help_request-PUT__entry__2}{#remote_help_request-PUT__version-RESTAPI}

| 이름 | 설명 |
|-|-|
| api_version | 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 <kbd class="ph userinput">v1</kbd> 또는 <kbd class="ph userinput">v2</kbd>입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열 |
| req_defn_id | 요청 정의의 고유 ID입니다. 이 값은 원격 요청 정의 \[sn_ind_rmt_help_request_defn\] 테이블의 ID 열에 해당합니다. 데이터 유형: 문자열 |
| task_id | 업데이트할 작업의 Sys_id입니다. 이 필드는 EMR 시스템에서 제공합니다. 데이터 유형: 문자열 |
[표 7. 경로 매개변수]

{#remote_help_request-PUT__entry__10}

| 이름 | 설명 |
|-|-|
| 없음 |   |
[표 8. 쿼리 매개변수]

{#remote_help_request-PUT__entry__14}

| 이름 | 설명 |
|-|-|
| request_data | 필수 원격 요청 데이터 \[sn_ind_rmt_help_request_data\] 테이블 또는 해당 하위 테이블을 업데이트하기 위한 EMR 시스템의 요청 데이터 이름-값 쌍입니다. 예: "request_data": { "additional_info" : "Please contact my office for more information." } 주: 객체의 요청 정의에 구성된 매개변수만 request_data 전달합니다. 다른 매개변수는 무시됩니다. 자세한 내용은 [EMR 시스템에 대한 요청 정의 구성을](https://www.servicenow.com/docs/access?context=configure-emr-help-req-def&version=xanadu&pubname=xanadu-healthcare-life-sciences&ft:locale=en-US) 참조하세요. 데이터 유형: 객체 |
| 소스 | 필수 요청 정의에 지정된 대로 엔드포인트를 호출하는 EMR 시스템의 이름입니다. 예: "source":"Cerner" 데이터 유형: 문자열 |
| task_parameters | 필수 IT 서비스 요청의 작업 매개변수를 설명하는 이름-값 쌍입니다. 객체의 각 요소는 인시던트 \[incident\] 테이블과 같은 해당 작업 테이블의 열에 해당됩니다. 예: "task_parameters": { "impact":"1", "contact_type":"phone" } 주: 객체의 요청 정의에 구성된 매개변수만 task_parameters 전달합니다. 다른 매개변수는 무시됩니다. 자세한 내용은 [EMR 시스템에 대한 요청 정의 구성을](https://www.servicenow.com/docs/access?context=configure-emr-help-req-def&version=xanadu&pubname=xanadu-healthcare-life-sciences&ft:locale=en-US) 참조하세요. 데이터 유형: 객체 |
[표 9. 요청 본문 매개변수(JSON)]

### 헤더

다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 [지원되는 REST API 헤더를](https://servicenow-prod.fluidtopics.net/JHL64oGR2SkU25ZTkfHy7g "REST(REpresentational State Transfer)는 웹상의 컴퓨터 시스템 간에 표준을 제공하여 서로 보다 쉽게 통신할 수 있게 지원하는 단순한 상태 비저장 아키텍처입니다.") 참조하세요.
{#remote_help_request-PUT__table_wvv_2yf_snb__entry__2}{#remote_help_request-PUT__accept-JSON-only-entry-RESTAPI}{#remote_help_request-PUT__content_type-JSON-only-entry-RESTAPI}

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

{#remote_help_request-PUT__table_wvv_2yf_snb} {#remote_help_request-PUT__entry__28}

| 헤더 | 설명 |
|-|-|
| 없음 |   |
[표 11. 응답 헤더]

### 상태 코드

다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 [REST API HTTP 응답 코드를](https://servicenow-prod.fluidtopics.net/JHL64oGR2SkU25ZTkfHy7g "REST(REpresentational State Transfer)는 웹상의 컴퓨터 시스템 간에 표준을 제공하여 서로 보다 쉽게 통신할 수 있게 지원하는 단순한 상태 비저장 아키텍처입니다.") 참조하세요.
{#remote_help_request-PUT__entry__32}{#remote_help_request-PUT__entry-200-status-code}{#remote_help_request-PUT__entry-401-status-code}{#remote_help_request-PUT__entry-500-status-code}

| 상태 코드 | 설명 |
|-|-|
| 200 | 성공입니다. 요청이 성공적으로 처리되었습니다. |
| 401 | 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다. |
| 500 | 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다. |
[표 12. 상태 코드]

### 응답 본문 매개변수(JSON)

{#remote_help_request-PUT__entry__40}

| 이름 | 설명 |
|-|-|
| 결과 | 결과 객체입니다. "result": { "code": "String", "error": "String", "errorTranslated": "String", "status": "String", "warning": "String", "warningTranslated": "String" } 데이터 유형: 객체 |
| 결과.코드 | 가 실패로 반환될 경우 result.status 의 애플리케이션 오류 코드입니다. 데이터 유형: 문자열 |
| 결과.오류 | 실패인 경우 result.status 포함되는 오류 메시지입니다. 이 메시지는 영어로만 작성됩니다. 데이터 유형: 문자열 |
| result.errorTranslated | 지역화된 오류 메시지(선택 사항)입니다. 데이터 유형: 문자열 |
| 결과.상태 | 응답 상태입니다. 유효한 값은 다음과 같습니다. * 성공 * 실패 {#remote_help_request-PUT__ul_awy_1dk_snb} 데이터 유형: 문자열 |
| 결과.경고 | 선택적 경고 메시지입니다. 성공할 경우 result.status 포함될 수 있습니다. 이 메시지는 영어로만 작성됩니다. 데이터 유형: 문자열 |
| result.warning번역됨 | 지역화된 경고 메시지(선택 사항)입니다. 데이터 유형: 문자열 |
[ ]

### cURL 요청

Cerner EMR 시스템에서 이전에 생성된 IT 서비스 요청 업데이트

    curl "https://instance.servicenow.com/api/sn_ind_rmt_help/v1/remote_help_request/sn_it_request/task/207e57c1db60a410f50fdc5b4b96192e"
    --request PUT \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --data "{
      "source":"Cerner",
      "task_parameters":{
        "impact":"1",
        "contact_type":"phone"
      },
      "request_data":{
        "additional_info" : "Please contact my office for more information."
      }
    }" \
    --user "username":"password"

다음 출력은 성공 응답과 오류 응답을 모두 보여줍니다.

    // Successful response
    {
      "result": {
        "status": "success"
      }
    }

    // Error response
    {
          {
          "result": {
          "status": "failure",
          "code": "1018",
          "error": "Record with sys_id 207e57js1db60a410f50fdc5b4b96192e does not exist in table incident",
          "errorTranslated": "Record with sys_id 207e57js1db60a410f50fdc5b4b96192e incident does not exist in table incident"
          }
          }
          }

## 원격 지원 요청 - GET /remote_help_request/{req_defn_id} {#ariaid-title4}

지정된 ID 및 쿼리 필터와 일치하는 작업 목록을 가져옵니다.
주:  
* 참조 및 선택 유형 필드는 항상 값과 display_value 있는 JSON 객체로 반환됩니다.
* DateTime 필드는 문자열로 반환되며 항상 UTC로 반환됩니다.
{#remote_help_request-GET__ul_nwf_z1f_tnb}

### URL 형식

버전이 지정된 URL: /api/sn_ind_rmt_help/{api_version}/remote_help_request/{req_defn_id}

기본 URL: /api/sn_ind_rmt_help/remote_help_request/{req_defn_id}

### 지원되는 요청 매개변수

{#remote_help_request-GET__entry__2}{#remote_help_request-GET__version-RESTAPI}

| 이름 | 설명 |
|-|-|
| api_version | 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 <kbd class="ph userinput">v1</kbd> 또는 <kbd class="ph userinput">v2</kbd>입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열 |
| req_defn_id | 업데이트할 요청 정의의 고유 ID입니다. 이 값은 원격 요청 정의 \[sn_ind_rmt_help_request_defn\] 테이블의 ID 열에 해당합니다. 데이터 유형: 문자열 |
[표 13. 경로 매개변수]

{#remote_help_request-GET__entry__8}

| 이름 | 설명 |
|-|-|
| 쿼리 | 필수 결과 집합을 필터링하는 데 사용되는 [인코딩된 쿼리](https://www.servicenow.com/docs/access?context=c_EncodedQueryStrings&version=xanadu&pubname=xanadu-platform-user-interface&ft:locale=en-US)입니다. 데이터 유형: 문자열 |
[표 14. 쿼리 매개변수]

{#remote_help_request-GET__entry__12}

| 이름 | 설명 |
|-|-|
| 없음 |   |
[표 15. 요청 본문 매개변수]

### 헤더

다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 [지원되는 REST API 헤더를](https://servicenow-prod.fluidtopics.net/JHL64oGR2SkU25ZTkfHy7g "REST(REpresentational State Transfer)는 웹상의 컴퓨터 시스템 간에 표준을 제공하여 서로 보다 쉽게 통신할 수 있게 지원하는 단순한 상태 비저장 아키텍처입니다.") 참조하세요.
{#remote_help_request-GET__table_wvv_2yf_snb__entry__2}{#remote_help_request-GET__accept-JSON-only-entry-RESTAPI}

| 헤더 | 설명 |
|-|-|
| 수용 | 응답 본문의 데이터 형식입니다. application/json만 지원합니다. |
[표 16. 요청 헤더]

{#remote_help_request-GET__table_wvv_2yf_snb} {#remote_help_request-GET__entry__20}

| 헤더 | 설명 |
|-|-|
| 없음 |   |
[표 17. 응답 헤더]

### 상태 코드

다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 [REST API HTTP 응답 코드를](https://servicenow-prod.fluidtopics.net/JHL64oGR2SkU25ZTkfHy7g "REST(REpresentational State Transfer)는 웹상의 컴퓨터 시스템 간에 표준을 제공하여 서로 보다 쉽게 통신할 수 있게 지원하는 단순한 상태 비저장 아키텍처입니다.") 참조하세요.
{#remote_help_request-GET__entry__24}{#remote_help_request-GET__entry-200-status-code}{#remote_help_request-GET__entry-401-status-code}{#remote_help_request-GET__entry-500-status-code}

| 상태 코드 | 설명 |
|-|-|
| 200 | 성공입니다. 요청이 성공적으로 처리되었습니다. |
| 401 | 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다. |
| 500 | 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다. |
[표 18. 상태 코드]

### 응답 본문 매개변수(JSON)

{#remote_help_request-GET__entry__32}

| 이름 | 설명 |
|-|-|
| 결과 | 결과를 반환합니다. "result": { "code": "String", "error": "String", "errorTranslated": "String", "status": "String", "task_list": [Array], "warning": "String", "warningTranslated": "String" } 데이터 유형: 객체 |
| 결과.코드 | 가 실패로 반환될 경우 result.status 의 애플리케이션 오류 코드입니다. 데이터 유형: 문자열 |
| 결과.오류 | 실패인 경우 result.status 포함되는 오류 메시지입니다. 이 메시지는 영어로만 작성됩니다. 데이터 유형: 문자열 |
| result.errorTranslated | 지역화된 오류 메시지(선택 사항)입니다. 데이터 유형: 문자열 |
| 결과.상태 | 응답 상태입니다. 가능한 값: * 실패 * 성공 데이터 유형: 문자열 |
| result.task_list | 작업 목록입니다. 데이터 유형: 배열 |
| 결과.경고 | 선택적 경고 메시지입니다. 성공할 경우 result.status 포함될 수 있습니다. 이 메시지는 영어로만 작성됩니다. 데이터 유형: 문자열 |
| result.warning번역됨 | 지역화된 경고 메시지(선택 사항)입니다. 데이터 유형: 문자열 |
[ ]

### cURL 요청

Cerner EMR 시스템에서 데이터 가져오기

    curl "https://instance.servicenow.com/api/remote_help_request/v1/sn_it_request/?query=active=true" \ 
    --header "Accept: application/json" \
    --header "Content-Type: application/json"
    {
      "source":"Cerner",
    } \
    --user "username":"password"

다음 출력은 성공 응답과 오류 응답을 모두 보여줍니다.

    // Successful response
    {
      "result": {
        "status": "success",
        "task_list": [
          {
            "number": "INC0010096",
            "short_description": "Unable to load data - 1",
            "assigned_to": {
              "value": "7a381da2dbfb5410f50fdc5b4b9619f2",
              "display_value": "Abel Tuter (IT agent)"
            },
            "opened_at": "2020-11-16 18:37:57",
            "closed_at": "",
            "closed_by": {},
            "state": {
              "value": "2",
              "display_value": "In Progress"
            },
            "priority": {
              "value": "5",
              "display_value": "5 - Planning"
            },
            "resolved_at": "",
            "resolved_by": {},
            "task_id": "207e57c1db60a410f50fdc5b4b96192e"
          },
          {
            "number": "INC0010095",
            "short_description": "Application freezes intermittently 3",
            "assigned_to": {},
            "opened_at": "2020-11-16 18:32:05",
            "closed_at": "",
            "closed_by": {},
            "state": {
              "value": "1",
              "display_value": "New"
            },
            "priority": {
              "value": "5",
              "display_value": "5 - Planning"
            },
            "resolved_at": "",
            "resolved_by": {},
            "task_id": "561d1f8ddb20a410f50fdc5b4b9619da"
          }
        ]
      }
    }

    // Error response
    {
      "result": {
      "status": "failure",
      "code": "1019",
      "error": "Invalid query in the request for table incident",
      "errorTranslated": "Invalid query in the request for table incident"
    }

## 원격 도움말 요청 - GET /remote_help_request/{req_defn_id}/task/{task_id} {#ariaid-title5}

에 task_id지정된 대로 단일 작업을 가져옵니다.
요청 정의 ID와 작업 ID를 지정하고 작업 상세 정보를 검색할 수 있습니다.  
주:  
* 참조 및 선택 유형 필드는 항상 값과 display_value 있는 JSON 객체로 반환됩니다.
* DateTime 필드는 문자열로 반환되며 항상 UTC로 반환됩니다.
* 저널 유형 필드에서는 추가 코멘트만 지원됩니다.
* 추가 주석은 개체의 JSON 배열로 다시 전달됩니다. 각 객체는 , created_by및 필드가 있는 created_on주석을 value 나타냅니다. 최신 의견이 먼저 전송됩니다.
{#remote_help_request-GET-task__ul_nwf_z1f_tnb}

### URL 형식

버전이 지정된 URL: /api/sn_ind_rmt_help/{api_version}/remote_help_request/{req_defn_id}/task/{task_id}

기본 URL: /api/sn_ind_rmt_help/remote_help_request/{req_defn_id}/task/{task_id}

### 지원되는 요청 매개변수

{#remote_help_request-GET-task__entry__2}{#remote_help_request-GET-task__version-RESTAPI}

| 이름 | 설명 |
|-|-|
| api_version | 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 <kbd class="ph userinput">v1</kbd> 또는 <kbd class="ph userinput">v2</kbd>입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열 |
| req_defn_id | 요청 정의의 고유 ID입니다. 이 값은 원격 요청 정의 \[sn_ind_rmt_help_request_defn\] 테이블의 ID 열에 해당합니다. 데이터 유형: 문자열 |
| task_id | 반환할 작업의 Sys_id입니다. 이 필드는 EMR 시스템에서 제공합니다. 데이터 유형: 문자열 |
[표 19. 경로 매개변수]

{#remote_help_request-GET-task__table_kpn_51f_tnb__entry__2}

| 이름 | 설명 |
|-|-|
| 없음 |   |
[표 20. 쿼리 매개변수]

{#remote_help_request-GET-task__table_kpn_51f_tnb} {#remote_help_request-GET-task__entry__14}

| 이름 | 설명 |
|-|-|
| 없음 |   |
[표 21. 요청 본문 매개변수]

### 헤더

다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 [지원되는 REST API 헤더를](https://servicenow-prod.fluidtopics.net/JHL64oGR2SkU25ZTkfHy7g "REST(REpresentational State Transfer)는 웹상의 컴퓨터 시스템 간에 표준을 제공하여 서로 보다 쉽게 통신할 수 있게 지원하는 단순한 상태 비저장 아키텍처입니다.") 참조하세요.
{#remote_help_request-GET-task__table_wvv_2yf_snb__entry__2}{#remote_help_request-GET-task__accept-JSON-only-entry-RESTAPI}

| 헤더 | 설명 |
|-|-|
| 수용 | 응답 본문의 데이터 형식입니다. application/json만 지원합니다. |
[표 22. 요청 헤더]

{#remote_help_request-GET-task__table_wvv_2yf_snb} {#remote_help_request-GET-task__entry__22}

| 헤더 | 설명 |
|-|-|
| 없음 |   |
[표 23. 응답 헤더]

### 상태 코드

다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 [REST API HTTP 응답 코드를](https://servicenow-prod.fluidtopics.net/JHL64oGR2SkU25ZTkfHy7g "REST(REpresentational State Transfer)는 웹상의 컴퓨터 시스템 간에 표준을 제공하여 서로 보다 쉽게 통신할 수 있게 지원하는 단순한 상태 비저장 아키텍처입니다.") 참조하세요.
{#remote_help_request-GET-task__entry__26}{#remote_help_request-GET-task__entry-200-status-code}{#remote_help_request-GET-task__entry-401-status-code}{#remote_help_request-GET-task__entry-500-status-code}

| 상태 코드 | 설명 |
|-|-|
| 200 | 성공입니다. 요청이 성공적으로 처리되었습니다. |
| 401 | 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다. |
| 500 | 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다. |
[표 24. 상태 코드]

### 응답 본문 매개변수(JSON)

{#remote_help_request-GET-task__entry__34}

| 이름 | 설명 |
|-|-|
| 결과 | 결과를 반환합니다. "result": { "code": "String", "error": "String", "errorTranslated": "String", "status": "String", "task_parameters": {Object}, "warning": "String", "warningTranslated": "String" } 데이터 유형: 객체 |
| 결과.코드 | 가 실패로 반환될 경우 result.status 의 애플리케이션 오류 코드입니다. 데이터 유형: 문자열 |
| 결과.오류 | 실패인 경우 result.status 포함되는 오류 메시지입니다. 이 메시지는 영어로만 작성됩니다. 데이터 유형: 문자열 |
| result.errorTranslated | 지역화된 오류 메시지(선택 사항)입니다. 데이터 유형: 문자열 |
| 결과.상태 | 응답 상태입니다. 가능한 값: * 실패 * 성공 데이터 유형: 문자열 |
| result.task_parameters | 필수 IT 서비스 요청의 작업 매개변수를 설명하는 이름-값 쌍입니다. 객체의 각 요소는 인시던트 \[incident\] 테이블과 같은 해당 작업 테이블의 열에 해당됩니다. 데이터 유형: 객체 |
| 결과.경고 | 선택적 경고 메시지입니다. 성공할 경우 result.status 포함될 수 있습니다. 이 메시지는 영어로만 작성됩니다. 데이터 유형: 문자열 |
| result.warning번역됨 | 지역화된 경고 메시지(선택 사항)입니다. 데이터 유형: 문자열 |
[ ]

### cURL 요청

Cerner EMR 시스템에서 데이터 가져오기

    curl "https://instance.servicenow.com/api/sn_ind_rmt_help/v1/remote_help_request/sn_it_request/task/207e57c1db60a410f50fdc5b4b96192e"\ 
    --request GET \ 
    --header "Accept: application/json"\ 
    --user "username":"password"

다음 출력은 성공 응답과 오류 응답을 모두 보여줍니다.

    // Successful response
    {
      "result": {
        "status": "success",
        "task_parameters": {
          "number": "INC0010096",
          "short_description": "Unable to load data - 1",
          "state": {
            "value": "2",
          "display_value": "In Progress"
          },
          "assigned_to": {
            "value": "7a381da2dbfb5410f50fdc5b4b9619f2",
            "display_value": "Abel Tuter (IT agent)"
          },
          "priority": {
            "value": "5",
            "display_value": "5 - Planning"
          },
          "caller_id": {
          "value": "82d4ecb4db40e8100e28aa594b96195c",
          "display_value": "Abel Tuter Requester"
        },
        "opened_at": "2020-11-16 18:37:57",
        "closed_at": "",
        "closed_by": {},
        "description": "",
        "impact": {
          "value": "1",
          "display_value": "1 - High"
        },
        "opened_by": {
          "value": "82d4ecb4db40e8100e28aa594b96195c",
          "display_value": "Abel Tuter Requester"
        },
        "close_code": {},
        "close_notes": "",
        "urgency": {
          "value": "3",
          "display_value": "3 - Low"
        },
        "category": {
          "value": "inquiry",
          "display_value": "Inquiry / Help"
        },
        "resolved_at": "",
        "resolved_by": {},
        "comments": [
          {
            "created_on": "2020-11-17 18:20:04",  
            "created_by": "Abel Tuter Requester",
            "value": "You can reach me during office hours."
          },
          {
            "created_on": "2020-11-16 18:40:14",
            "created_by": "Abel Tuter Requester",
            "value": "You can reach me during office hours."
          },
          {
            "created_on": "2020-11-16 18:38:29",
            "created_by": "Abel Tuter",
            "value": "Hello there\rName of app please"
          }],
        "task_id": "207e57c1db60a410f50fdc5b4b96192e"
        }
      }
    }

    // Error response
    {
      "result": {
        "status": "failure",
        "code": "1001",
        "error": "Invalid request definition: test_request2",
        "errorTranslated": "Invalid request definition: test_request2"
      }
    }