---
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


---

# 약속 오픈 - /sn_tmf_api/약속/약속 게시

# 약속 오픈 - /sn_tmf_api/약속/약속 게시 {#ariaid-title1}

* 릴리스 버전: Xanadu
* 
* 업데이트 날짜 2024년 08월 01일
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 소요 시간: 10분

작업 주문에 대한 약속을 예약할 수 있습니다.

## URL 형식

/api/sn_tmf_api/약속/약속

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

{#apptOpen-POST-appointment__table_lr2_mwt_dcc__entry__2}

| 이름 | 설명 |
|-|-|
| 없음 |   |
[표 1. 경로 매개변수]

{#apptOpen-POST-appointment__table_lr2_mwt_dcc} {#apptOpen-POST-appointment__entry__6}

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

{#apptOpen-POST-appointment__entry__10}{#apptOpen-POST-appointment__serviceTest-response-testMeasureDefinition.thresholdRule.consequence.validFor}{#apptOpen-POST-appointment__serviceTest-response-testMeasureDefinition.thresholdRule.consequence.validFor.startDateTime}{#apptOpen-POST-appointment__serviceTest-response-testMeasureDefinition.thresholdRule.consequence.validFor.endDateTime}

| 이름 | 설명 |
|-|-|
| 범주 | 필수 약속 예약 서비스 구성을 위해 구성된 기록 생성자의 sys_id입니다. 기록 생성자는 관련 약속 예약 서비스 구성 기록 - 약속 예약 서비스 구성\[sn_apptmnt_booking_service_config\] 테이블의 카탈로그 항목 필드에 정의됩니다. 데이터 유형: 문자열 |
| 관련 엔터티 | 영향을 받는 작업 주문의 목록입니다. 데이터 유형: 배열 "relatedEntity": [ { "id": "String", "@referredType": "String" } ] |
| relatedEntity.id | 필수 작업 주문 \[wm_order\] 테이블에 있는 기록의 sys_id입니다. 데이터 유형: 문자열 |
| relatedEntity.@referredType | 항목 또는 서비스의 유형입니다. 예를 들면 `WorkOrder`와 같습니다. 데이터 유형: 문자열 |
| relatedEntity.role | 엔터티 역할에 대한 설명입니다. 예를 들어, `작업 주문`입니다. 데이터 유형: 문자열 |
| 관련파티 | 약속의 연락처 목록입니다. 각 접점은 배열의 개체입니다. 요청에는 고객 계정 정보가 포함된 하나 이상의 항목이 나열되어야 합니다. 데이터 유형: 배열 "relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "role": "String" } ] |
| relatedParty.id | 필수 작업 주문과 관련된 고객 접촉 창구의 sys_id 또는 external_id입니다. 연락처 \[customer_contact\] 테이블에 있습니다. 데이터 유형: 문자열 |
| relatedParty.name | 고객의 이름입니다. 데이터 유형: 문자열 |
| relatedParty.@referredType | 고객 유형입니다. 예를 들면 `개인`입니다. 데이터 유형: 문자열 |
| relatedParty.role | 필수 미리 정의된 연락처 역할입니다. 예: `고객`. 데이터 유형: 문자열 |
| 관련장소 | 약속과 관련된 위치 목록입니다. "relatedPlace": [ { "id": "String", "name": "String", "@referredType": "String", "role": "String" } ] 데이터 유형: 배열 |
| relatedPlace.id | 필수 위치\[cmn_location\] 테이블에 나열된 장소의 sys_id입니다. 데이터 유형: 문자열 |
| relatedPlace.name | 위치\[cmn_location\] 테이블에 나열된 장소의 이름입니다. 예: `251 Reddy St, Darwin, CA 93522`. 데이터 유형: 문자열 |
| relatedPlace.@referredType | 위치의 유형입니다. 예를 들면 `구/군/시`입니다. 데이터 유형: 문자열 |
| relatedPlace.role | 위치 역할에 대한 설명입니다. 예를 들어, 작업 주문입니다. 데이터 유형: 문자열 |
| 시간대 | 필수 지정된 약속 슬롯을 예약할 때 사용할 시간대입니다. |
| validFor | 필수 약속이 유효한 날짜 범위입니다. 데이터 유형: 객체 "validFor": { "startDateTime": "String", "endDateTime": "String" } |
| validFor.startDateTime | 시간 슬롯의 시작 날짜입니다. 형식: YYYY-MM-DD 00:00:00. 예: `2025-01-31 09:35:43`. 데이터 유형: 문자열 |
| validFor.endDateTime | 시간 슬롯의 종료 날짜입니다. 형식: YYYY-MM-DD 00:00:00. 예: `2025-01-31 09:35:43`. 데이터 유형: 문자열 |
[표 3. 요청 본문 매개변수]

## 헤더

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

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

{#apptOpen-POST-appointment__entry__54}{#apptOpen-POST-appointment__content_type-JSON-only-entry-RESTAPI}

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

## 상태 코드

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

| 상태 코드 | 설명 |
|-|-|
| 200 | 성공입니다. 요청이 성공적으로 처리되었습니다. |
| 500 | 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다. |
[표 6. 상태 코드]

## 응답 본문 매개변수

{#apptOpen-POST-appointment__entry__64}

| 이름 | 설명 |
|-|-|
| 범주 | 약속 예약 서비스 구성을 위해 구성된 기록 생성자의 sys_id입니다. 기록 생성자는 관련 약속 예약 서비스 구성 기록 - 약속 예약 서비스 구성\[sn_apptmnt_booking_service_config\] 테이블의 카탈로그 항목 필드에 정의됩니다. 데이터 유형: 문자열 |
| creationDate | 약속 기록이 만들어진 날짜 및 시간입니다. 데이터 유형: 문자열 |
| id | 생성된 약속의 sys_id입니다. 약속 예약 서비스 구성 \[sn_apptmnt_booking_service_config\] 테이블에 있습니다. 데이터 유형: 문자열 |
| href | 약속 기록에 대한 상대 링크입니다. 데이터 유형: 문자열 |
| 마지막 업데이트 | 약속 기록이 마지막으로 업데이트된 날짜 및 시간입니다. 데이터 유형: 문자열 |
| 관련 엔터티 | 영향을 받는 작업 주문의 목록입니다. 데이터 유형: 배열 "relatedEntity": [ { "id": "String", "@referredType": "String" } ] |
| relatedEntity.id | 작업 주문 \[wm_order\] 테이블에 있는 기록의 sys_id입니다. 데이터 유형: 문자열 |
| relatedEntity.@referredType | 항목 또는 서비스의 유형입니다. 데이터 유형: 문자열 |
| relatedEntity.role | 엔터티 역할에 대한 설명입니다. 데이터 유형: 문자열 |
| 관련파티 | 약속의 연락처 목록입니다. 각 접점은 배열의 개체입니다. 요청에는 고객 계정 정보가 포함된 하나 이상의 항목이 나열되어야 합니다. 데이터 유형: 배열 "relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "role": "String" } ] |
| relatedParty.id | 작업 주문과 관련된 고객 접촉 창구의 sys_id 또는 external_id입니다. 연락처 \[customer_contact\] 테이블에 있습니다. 데이터 유형: 문자열 |
| relatedParty.name | 고객의 이름입니다. 데이터 유형: 문자열 |
| relatedParty.@referredType | 고객 유형입니다. 데이터 유형: 문자열 |
| relatedParty.role | 미리 정의된 연락처 역할입니다. 데이터 유형: 문자열 |
| 관련장소 | 약속과 관련된 위치 목록입니다. "relatedPlace": [ { "id": "String", "name": "String", "@referredType": "String", "role": "String" } ] 데이터 유형: 배열 |
| relatedPlace.id | 위치\[cmn_location\] 테이블에 나열된 장소의 sys_id입니다. 데이터 유형: 문자열 |
| relatedPlace.name | 위치\[cmn_location\] 테이블에 나열된 장소의 이름입니다. 데이터 유형: 문자열 |
| relatedPlace.@referredType | 위치의 유형입니다. 데이터 유형: 문자열 |
| relatedPlace.role | 위치 역할에 대한 설명입니다. 데이터 유형: 문자열 |
| 시간대 | 지정된 약속 슬롯을 예약할 때 사용할 시간대입니다. |
| validFor | 약속이 유효한 날짜 범위입니다. 데이터 유형: 객체 "validFor": { "startDateTime": "String", "endDateTime": "String" } |
| validFor.startDateTime | 시간 슬롯의 시작 날짜입니다. 데이터 유형: 문자열 |
| validFor.endDateTime | 시간 슬롯의 종료 날짜입니다. 데이터 유형: 문자열 |
| 성공 | 요청이 성공했는지 여부를 나타내는 플래그입니다. 가능한 값: * true: 요청이 성공했습니다. * false: 요청에 실패했습니다. 데이터 유형: 부울 |
[ ]

## cURL 요청

다음 예제에서는 새 약속 예약을 만드는 방법을 보여 줍니다.

    curl "https://instance.servicenow.com/api/sn_tmf_api/appointment/appointment" \
    --request POST \
    --header "Accept:application/json" \
    --header "Content-Type:application/json" \
    --data "{
      \"validFor\": {
        \"startDateTime\": \"2024-08-19 09:00:00\",
        \"endDateTime\": \"2024-08-19 11:00:00\"
      },
      \"category\": \"e4c1116b3b810300ce8a4d72f3efc40f\",
      \"relatedParty\": [
        {
          \"id\": \"eaf68911c35420105252716b7d40ddde\",
          \"name\": \"Sally Thomas\",
          \"role\": \"customer\",
          \"@referredType\": \"Individual\"
        }
      ],
      \"relatedPlace\": {
        \"id\": \"25ab9c4d0a0a0bb300f7dabdc0ca7c1c\",
        \"name\": \"100 South Charles Street, Baltimore,MD\",
        \"role\": \"interventionAddress\",
        \"@referredType\": \"GeographicAddress\"
      },
      \"relatedEntity\": [
        {
          \"id\": \"48dbfbf9201f0250f877303e8a020dcd\",
          \"role\": \"work order\",
          \"@referredType\": \"WorkOrder\"
        }
      ],
      \"timeZone\": \"US/Arizona\"
    }" \
    --user 'username':'password'

응답:

    {
      "validFor": {
        "startDateTime": "2024-07-19 09:00:00",
        "endDateTime": "2024-07-19 11:00:00"
      },
      "category": "e4c1116b3b810300ce8a4d72f3efc40f",
      "relatedParty": [
        {
          "id": "eaf68911c35420105252716b7d40ddde",
          "name": "Sally Thomas",
          "role": "customer",
          "@referredType": "Individual"
        }
      ],
      "relatedPlace": {
        "id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
        "name": "100 South Charles Street, Baltimore,MD",
        "role": "interventionAddress",
        "@referredType": "GeographicAddress"
      },
      "relatedEntity": [
        {
          "id": "48dbfbf9201f0250f877303e8a020dcd",
          "role": "work order",
          "@referredType": "WorkOrder"
        }
      ],
      "timeZone": "US/Arizona",
      "success": true,
      "id": "feacb7f9201f0250f877303e8a020d38",
      "href": "api/sn_tmf_api/appointment/appointment/feacb7f9201f0250f877303e8a020d38",
      "creationDate": "2024-07-10 22:45:01",
      "lastUpdate": "2024-07-10 22:45:01"
    }