약속 오픈 - /sn_tmf_api/약속/약속 게시
작업 주문에 대한 약속을 예약할 수 있습니다.
URL 형식
/api/sn_tmf_api/약속/약속
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| 없음 |
| 이름 | 설명 |
|---|---|
| 없음 |
| 이름 | 설명 |
|---|---|
| 범주 | 필수 약속 예약 서비스 구성을 위해 구성된 기록 생성자의 sys_id입니다. 기록 생성자는 관련 약속 예약 서비스 구성 기록 - 약속 예약 서비스 구성[sn_apptmnt_booking_service_config] 테이블의 카탈로그 항목 필드에 정의됩니다. 데이터 유형: 문자열 |
| 관련 엔터티 | 영향을 받는 작업 주문의 목록입니다. 데이터 유형: 배열 |
| relatedEntity.id | 필수 작업 주문 [wm_order] 테이블에 있는 기록의 sys_id입니다. 데이터 유형: 문자열 |
| relatedEntity.@referredType | 항목 또는 서비스의 유형입니다. 예를 들면 WorkOrder와 같습니다.데이터 유형: 문자열 |
| relatedEntity.role | 엔터티 역할에 대한 설명입니다. 예를 들어, 작업 주문입니다.데이터 유형: 문자열 |
| 관련파티 | 약속의 연락처 목록입니다. 각 접점은 배열의 개체입니다. 요청에는 고객 계정 정보가 포함된 하나 이상의 항목이 나열되어야 합니다. 데이터 유형: 배열 |
| relatedParty.id | 필수 작업 주문과 관련된 고객 접촉 창구의 sys_id 또는 external_id입니다. 연락처 [customer_contact] 테이블에 있습니다. 데이터 유형: 문자열 |
| relatedParty.name | 고객의 이름입니다. 데이터 유형: 문자열 |
| relatedParty.@referredType | 고객 유형입니다. 예를 들면 개인입니다.데이터 유형: 문자열 |
| relatedParty.role | 필수 미리 정의된 연락처 역할입니다. 예: 고객.데이터 유형: 문자열 |
| 관련장소 | 약속과 관련된 위치 목록입니다.데이터 유형: 배열 |
| relatedPlace.id | 필수 위치[cmn_location] 테이블에 나열된 장소의 sys_id입니다. 데이터 유형: 문자열 |
| relatedPlace.name | 위치[cmn_location] 테이블에 나열된 장소의 이름입니다. 예: 251 Reddy St, Darwin, CA 93522.데이터 유형: 문자열 |
| relatedPlace.@referredType | 위치의 유형입니다. 예를 들면 구/군/시입니다.데이터 유형: 문자열 |
| relatedPlace.role | 위치 역할에 대한 설명입니다. 예를 들어, 작업 주문입니다. 데이터 유형: 문자열 |
| 시간대 | 필수 지정된 약속 슬롯을 예약할 때 사용할 시간대입니다. |
| validFor | 필수 약속이 유효한 날짜 범위입니다. 데이터 유형: 객체 |
| validFor.startDateTime | 시간 슬롯의 시작 날짜입니다. 형식: YYYY-MM-DD 00:00:00. 예: 데이터 유형: 문자열 |
| validFor.endDateTime | 시간 슬롯의 종료 날짜입니다. 형식: YYYY-MM-DD 00:00:00. 예: 데이터 유형: 문자열 |
헤더
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.
| 헤더 | 설명 |
|---|---|
| 수용 | 응답 본문의 데이터 형식입니다. application/json만 지원합니다. |
| 헤더 | 설명 |
|---|---|
| 컨텐츠-형식 | 요청 본문의 데이터 형식입니다. application/json만 지원합니다. |
상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.
| 상태 코드 | 설명 |
|---|---|
| 200 | 성공입니다. 요청이 성공적으로 처리되었습니다. |
| 500 | 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다. |
응답 본문 매개변수
| 이름 | 설명 |
|---|---|
| 범주 | 약속 예약 서비스 구성을 위해 구성된 기록 생성자의 sys_id입니다. 기록 생성자는 관련 약속 예약 서비스 구성 기록 - 약속 예약 서비스 구성[sn_apptmnt_booking_service_config] 테이블의 카탈로그 항목 필드에 정의됩니다. 데이터 유형: 문자열 |
| creationDate | 약속 기록이 만들어진 날짜 및 시간입니다. 데이터 유형: 문자열 |
| id | 생성된 약속의 sys_id입니다. 약속 예약 서비스 구성 [sn_apptmnt_booking_service_config] 테이블에 있습니다. 데이터 유형: 문자열 |
| href | 약속 기록에 대한 상대 링크입니다. 데이터 유형: 문자열 |
| 마지막 업데이트 | 약속 기록이 마지막으로 업데이트된 날짜 및 시간입니다. 데이터 유형: 문자열 |
| 관련 엔터티 | 영향을 받는 작업 주문의 목록입니다. 데이터 유형: 배열 |
| relatedEntity.id | 작업 주문 [wm_order] 테이블에 있는 기록의 sys_id입니다. 데이터 유형: 문자열 |
| relatedEntity.@referredType | 항목 또는 서비스의 유형입니다. 데이터 유형: 문자열 |
| relatedEntity.role | 엔터티 역할에 대한 설명입니다. 데이터 유형: 문자열 |
| 관련파티 | 약속의 연락처 목록입니다. 각 접점은 배열의 개체입니다. 요청에는 고객 계정 정보가 포함된 하나 이상의 항목이 나열되어야 합니다. 데이터 유형: 배열 |
| relatedParty.id | 작업 주문과 관련된 고객 접촉 창구의 sys_id 또는 external_id입니다. 연락처 [customer_contact] 테이블에 있습니다. 데이터 유형: 문자열 |
| relatedParty.name | 고객의 이름입니다. 데이터 유형: 문자열 |
| relatedParty.@referredType | 고객 유형입니다. 데이터 유형: 문자열 |
| relatedParty.role | 미리 정의된 연락처 역할입니다. 데이터 유형: 문자열 |
| 관련장소 | 약속과 관련된 위치 목록입니다.데이터 유형: 배열 |
| relatedPlace.id | 위치[cmn_location] 테이블에 나열된 장소의 sys_id입니다. 데이터 유형: 문자열 |
| relatedPlace.name | 위치[cmn_location] 테이블에 나열된 장소의 이름입니다. 데이터 유형: 문자열 |
| relatedPlace.@referredType | 위치의 유형입니다. 데이터 유형: 문자열 |
| relatedPlace.role | 위치 역할에 대한 설명입니다. 데이터 유형: 문자열 |
| 시간대 | 지정된 약속 슬롯을 예약할 때 사용할 시간대입니다. |
| validFor | 약속이 유효한 날짜 범위입니다. 데이터 유형: 객체 |
| validFor.startDateTime | 시간 슬롯의 시작 날짜입니다. 데이터 유형: 문자열 |
| validFor.endDateTime | 시간 슬롯의 종료 날짜입니다. 데이터 유형: 문자열 |
| 성공 | 요청이 성공했는지 여부를 나타내는 플래그입니다. 가능한 값:
데이터 유형: 부울 |
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"
}