WSD 검색 API
(WSD) 검색 API는 Workplace Service Delivery 예약 가능한 항목, 예약 가능한 모듈, 사용 가능한 교대조 등 사용 가능한 위치와 직장 항목을 검색할 수 있는 엔드포인트를 제공합니다.
이 API에 접근하려면 호출자에게 sn_wsd_core.workplace_user 역할이 있어야 하며 Workplace Safety Management(sn_wsd_core) 및 Workplace Reservation Management(sn_wsd_rsv) 플러그인이 활성화되어 있어야 합니다.
이 API는 sn_wsd_rsv 네임스페이스에서 실행됩니다.
에 대한 Workplace Reservation Management자세한 내용은 Workplace Reservation Management를 참조하십시오.
WSD 검색 - /api/sn_wsd_rsv/search/availability 가져오기
지정된 예약 가능 여부를 지정된 시간에 사용할 수 있는지 확인합니다.
URL 형식
버전이 지정된 URL: / api/sn_wsd_rsv/{api_version}/search/availability
기본 URL: / api/sn_wsd_rsv/search/availability
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| api_version | 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| 종료 | 필수 사용 가능한 예약 가능한 모듈을 검색하는 데 사용할 종료 시간입니다. 이 값은 매개 변수에 지정된 start 값보다 이후여야 합니다. 데이터 유형: 문자열 형식: UTC 또는 현지 시간(yyyy-mm-dd hh:mm:ss) |
| include_reservations_within_days | 하루 종일 예약 가능한 각 예약 가능한 항목에 대한 응답에서 사용 가능한 시간의 사용 가능한 슬롯을 모두 반환할지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 부울 기본값: false |
| reservable_ids | 필수 가용성을 평가할 예약 가능한 sys_ids의 쉼표로 구분된 목록입니다. 직장 위치[sn_wsd_core_workplace_location] 테이블에 있습니다. 데이터 유형: 문자열 |
| reservation_ids | 기존 예약 sys_ids의 쉼표로 구분된 목록입니다. 연결된 예약을 편집하려면 이 매개변수를 전달합니다. 직장 예약[sn_wsd_rsv_reservation] 테이블에 있습니다. 이러한 sys_ids에서 해당 예약 가능한 항목에 대해 차단된 시간은 사용 가능한 것으로 처리됩니다. 데이터 유형: 문자열 기본값: 없음 |
| reservable_module | 필수 검색에 포함할 예약 가능한 모듈의 Sys_id입니다. 예약 가능한 모듈은 유사한 유형의 직장 항목을 그룹화합니다. 예약 가능한 모듈 [sn_wsd_rsv_reservable_module] 테이블에 있습니다. 데이터 유형: 문자열 |
| schedule_view_obj | 반환할 일정 뷰에 대한 상세 정보입니다. 1일 이상 걸친 예약에 대해 24시간 가용성 데이터가 필요한 경우 이 개체를 전달합니다. 반환 결과에는 지정된 날짜의 사용 가능한 시간과 예약만 포함됩니다. 이 기능이 제대로 작동하려면 매개변수 ignore_same_day_validation 와 include_reservations_within_daystrue로 설정해야 합니다. 데이터 유형: 객체 |
| schedule_view_obj.일정_뷰_날짜 | 예약 가능 여부 반환을 시작할 날짜입니다. 이 날짜는 매개변수에 지정된 시간대에 schedule_view_obj.timezone 있어야 합니다. 데이터 유형: 문자열 형식: YYYY-MM-DD |
| schedule_view_obj.시간대 | 반환할 예약 가용성 데이터를 결정하는 데 사용할 건물 시간대입니다. 예: 미국/태평양. 데이터 유형: 문자열 |
| Shift | 지정된 예약 가능한 모듈이 교대조를 기반으로 하는 경우 필수입니다. 예약과 연결할 교대조의 Sys_id입니다. 교대조 [sn_wsd_core_shift] 테이블에 있습니다. 이 매개 변수가 전달 end 되면 매개 변수가 필요하지 않습니다. 교대조 기반 예약에 대한 자세한 내용은 교대조 기반 예약 사용을 참조하세요. 데이터 유형: 문자열 |
| 시작 | 필수 사용 가능한 예약 가능한 모듈을 검색하는 데 사용할 시작 시간입니다. 이 값은 매개변수에 end 지정된 값보다 커야 합니다. 데이터 유형: 문자열 형식: UTC 또는 현지 시간(yyyy-mm-dd hh:mm:ss) |
| 이름 | 설명 |
|---|---|
| 없음 |
헤더
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.
| 헤더 | 설명 |
|---|---|
| 수용 | 요청 본문의 데이터 형식입니다. 지원되는 유형: application/json, 또는, text/xmlapplication/xml . 기본값: application/json |
| 헤더 | 설명 |
|---|---|
| 없음 |
상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.
| 상태 코드 | 설명 |
|---|---|
| 200 | 성공입니다. 요청이 성공적으로 처리되었습니다. |
| 401 | 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다. |
| 404 | 찾을 수 없습니다. 요청한 항목을 찾을 수 없습니다. |
| 500 | 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다. |
응답 본문 매개변수
| 이름 | 설명 |
|---|---|
| 결과 | 지정된 시간에 사용할 수 있는 모든 자원 가능 항목의 목록입니다. 데이터 유형: 객체 배열 |
| result.availableTimes | 연결된 예약 가능한 날짜/시간의 목록입니다. 데이터 유형: 배열 |
| 결과.건물 | 예약 가능한 항목과 연결된 건물에 대한 상세 정보입니다. 데이터 유형: 객체 |
| result.building.display_value | 건물의 가치를 표시합니다. 데이터 유형: 문자열 |
| result.building.name | 건물의 이름입니다. 데이터 유형: 문자열 |
| result.building.sys_id | 관련된 건물 기록의 Sys_id입니다. 데이터 유형: 문자열 |
| 결과.캠퍼스 | 예약 가능한 항목과 연결된 캠퍼스에 대한 상세 정보입니다. 데이터 유형: 객체 |
| result.campus.display_value | 예약 가능 항목이 있는 캠퍼스 번호(예: 이스트 베이)를 표시합니다. 데이터 유형: 문자열 |
| result.campus.name | 캠퍼스의 이름입니다. 데이터 유형: 문자열 |
| result.campus.sys_id | 연결된 기록의 Sys_id입니다. 캠퍼스 [sn_wsd_core_campus] 테이블에 있습니다. 데이터 유형: 문자열 |
| result.email | 연결된 예약 가능한 항목의 이메일 주소입니다. 데이터 유형: 문자열 |
| 결과.바닥 | 예약 가능한 층과 연결된 층의 상세 정보입니다. 데이터 유형: 객체 |
| result.floor.display_value | 예약 가능한 층이 있는 층의 번호(예: 12)를 표시합니다. 데이터 유형: 문자열 |
| result.floor.name | 예약 가능한 항목이 있는 층의 이름입니다. 데이터 유형: 문자열 |
| result.floor.sys_id | 층 [sn_wsd_core_floor] 테이블에 있는 관련 기록의 Sys_id입니다. 데이터 유형: 문자열 |
| result.is_available | 예약 가능한 항목을 예약할 수 있는지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 부울 |
| result.name | 예약 가능한 항목의 이름입니다. 데이터 유형: 문자열 |
| 결과.예약 | 연결된 예약에 대한 상세 정보입니다. 데이터 유형: 객체 배열 |
| result.reservations.configuration_item | 예약에 해당하는 구성 항목입니다. cmdb_ci 테이블에 있습니다. 데이터 유형: 문자열 |
| 결과.예약.종료 | 예약 종료 날짜 및 시간입니다. 데이터 유형: 문자열 형식: UTC: yyyy-mm-ddThh:mm:ssZ(예: 2021-02-05T18:00:00Z) |
| result.reservations.is_collided | 예약이 검색 시작 및 종료 시간과 충돌하는지 여부를 나타내는 플래그입니다. 연결된 예약 가능한 위치가 지정된 검색 시간 범위에 대해 이미 예약되었음을 나타냅니다. 가능한 값:
데이터 유형: 부울 |
| 결과.예약.위치 | 예약 위치에 대한 상세 정보입니다. 데이터 유형: 객체 |
| 결과.예약.위치.위치 | 연결된 위치 기록의 Sys_id입니다. 직장 위치[sn_wsd_core_workplace_location] 테이블에 있습니다. 데이터 유형: 문자열 |
| 결과.예약.위치.시간대 | 위치와 연결된 시간대에 대한 상세 정보입니다. 데이터 유형: 객체 |
| result.reservations.location.timezone.displayValue | 이 위치가 속한 표준 시간대의 표시 값입니다. 데이터 유형: 문자열 |
| 결과.예약.위치.시간대.값 | 이 위치가 속한 표준 시간대의 내부 값입니다. 데이터 유형: 문자열 |
| 결과.예약.번호 | 예약 번호입니다. 데이터 유형: 문자열 |
| result.reservations.requested_for | 대신 예약을 요청한 사람에 대한 상세 정보입니다. 데이터 유형: 객체 |
| result.reservations.requested_for.name | 예약이 요청된 사용자의 이름입니다. 데이터 유형: 문자열 |
| result.reservations.requested_for.sys_id | 예약을 요청 중인 사용자의 Sys_id입니다. 사용자 [sys_user] 테이블에 있습니다. 데이터 유형: 문자열 |
| result.reservations.reservation_purpose | 예약의 목적에 대한 상세 정보입니다. 데이터 유형: 객체 |
| result.reservations.reservation_purpose.display_value | 회사 회의와 같은 예약 목적에 대한 값을 표시합니다. 데이터 유형: 문자열 |
| result.reservations.reservation_purpose.가치 | company_meeting과 같이 예약 목적에 대한 내부 값입니다. 데이터 유형: 문자열 |
| 결과.예약.시작 | 예약 시작 날짜 및 시간입니다. 데이터 유형: 문자열 형식: UTC - yyyy-mm-ddThh:mm:ssZ(예: 2021-02-05T18:00:00Z) |
| 결과.reservations.state | 위치의 예약 상태에 대한 상세 정보입니다. 데이터 유형: 객체 |
| result.reservations.state.display_value | 확인됨 등 예약의 현재 상태에 대한 값을 표시합니다. 데이터 유형: 문자열 |
| 결과.예약.상태.값 | 예약의 현재 상태에 대한 내부 값입니다(예: 2). 데이터 유형: 문자열 |
| 결과.예약.제목 | 예약의 주제입니다. 데이터 유형: 문자열 |
| result.reservations.sys_id | 필수 예약 기록의 Sys_id입니다. 직장 예약[sn_wsd_rsv_reservation] 테이블에 있습니다. 데이터 유형: 문자열 |
cURL 요청
다음 코드 예제에서는 이 끝점을 호출하는 방법을 보여 줍니다. 참고: 쉽게 읽을 수 있도록 쿼리 매개변수에 줄 바꿈이 추가되었습니다.
curl "https://instance.servicenow.com/api/sn_wsd_rsv/search/availability?
reservable_module=5db44502dbb650106c731dcd13961937&
start=2023-10-12T11:00:00Z&
end=2023-10-15T12:00:00Z&
reservable_ids=adb35f1977220110b3d7be377b5a99fc&
reservation_ids=undefined&
shift=undefined&
schedule_view_obj={"schedule_view_date":"2023-10-12","timezone":"Europe/Paris"}&
timezone=Europe/Paris&
include_reservations_within_days=true&
ignore_same_day_validation=true&
include_unavailable_items=true" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
반환 결과:
{
"result": [
{
"sys_id": "fe1f744edb7650106c731dcd139619ca",
"email": null,
"name": "Aspen",
"is_available": true,
"availableTimes": [
[
"2022-04-23 07:00:00",
"2022-04-23 08:30:00"
],
[
"2022-04-23 09:30:00",
"2022-04-23 23:00:00"
],
[
"2022-04-24 00:00:00",
"2022-04-24 06:59:59"
]
],
"floor": {
"sys_id": "2f554296dbba10106c731dcd139619ed",
"display_value": "Floor 2",
"name": "Floor 2"
},
"building": {
"sys_id": "94e264cedb3650106c731dcd13961919",
"display_value": "CAL-B1",
"name": "CAL-B1"
},
"campus": {
"sys_id": "82b2a0cedb3650106c731dcd139619e9",
"display_value": "California Campus",
"name": "California Campus"
},
"reservations": [
{
"sys_id": "5fe65830874bc9106342b846dabb352b",
"number": "WRES0001001",
"location": {
"location": "fe1f744edb7650106c731dcd139619ca",
"timezone": {
"value": "US/Pacific",
"displayValue": "US/Pacific"
}
},
"configuration_item": null,
"start": "2022-04-23T08:30:00Z",
"end": "2022-04-23T09:30:00Z",
"subject": null,
"reservation_purpose": {
"value": "meeting",
"display_value": "Meeting"
},
"state": {
"value": "confirmed",
"display_value": "Confirmed"
},
"is_collided": false,
"requested_for": {
"sys_id": "2de07e1887cb89106342b846dabb35fe",
"name": "Workplace User"
}
}
]
}
]
}
WSD 검색 - GET /api/sn_wsd_rsv/search/best_match
제공된 검색 기준에 따라 예약 가능한 가장 일치하는 항목을 검색합니다.
URL 형식
버전이 지정된 URL: / api/sn_wsd_rsv/{api_version}/search/best_match
기본 URL: / api/sn_wsd_rsv/search/best_match
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| api_version | 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| best_match_count | 반환할 가장 일치하는 예약 가능 수입니다. 데이터 유형: 숫자 기본값: 1 |
| 종료 | 필수 사용 가능한 예약 가능한 모듈을 검색하는 데 사용할 종료 시간입니다. 이 값은 매개 변수에 지정된 start 값보다 이후여야 합니다. 데이터 유형: 문자열 형식: UTC 또는 현지 시간(yyyy-mm-dd hh:mm:ss) |
| include_reservable_purposes | 반환 결과에서 각 예약 가능한 항목에 대한 직장 위치를 예약하는 목적을 반환할지 여부를 나타내는 플래그입니다. 이 정보는 예약 가능한 목적[sn_wsd_rsv_reservable_purpose] 테이블에 있습니다. 유효한 값은 다음과 같습니다.
데이터 유형: 부울 기본값: false |
| include_reservations_within_days | 하루 종일 예약 가능한 각 예약 가능한 항목에 대한 응답에서 사용 가능한 시간의 사용 가능한 슬롯을 모두 반환할지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 부울 기본값: false |
| include_standard_services | 응답에서 표준 서비스 정보를 반환할지 여부를 나타내는 플래그입니다. 표준 서비스는 화이트 보드, 추가 모니터 및 유사한 서비스와 같이 예약 가능한 직장 항목과 함께 사용할 수 있는 기본 조항을 설명합니다. 표준 서비스에 대한 자세한 내용은 표준 서비스를 참조하세요. 이 정보는 표준 서비스[sn_wsd_rsv_standard_service] 테이블에 있습니다. 유효한 값은 다음과 같습니다.
데이터 유형: 부울 기본값: false |
| q | 필수 검색 반환 결과를 필터링하는 데 사용할 인코딩된 쿼리입니다. 이 쿼리 내에서 건물 sys_id 지정해야 하며 층, 면적, 용량, 표준 서비스 및 reservable_purposes과 같은 매개변수를 지정할 수 있습니다. 숫자인 용량을 제외하고 전달된 모든 매개변수는 sys_ids여야 합니다. 예: q=building=94e264cedb3650106c731dcd13961919^floorINfc7368cedb3650106c731dcd13961902^capacity>=1^standard_services=55c0818edb7650106c731dcd13961904 다음 테이블에서 이 정보를 찾을 수 있습니다.
데이터 유형: 문자열 |
| reservable_module | 필수 검색에 포함할 예약 가능한 모듈의 Sys_id입니다. 예약 가능한 모듈은 유사한 유형의 직장 항목을 그룹화합니다. 예약 가능한 모듈 [sn_wsd_rsv_reservable_module] 테이블에 있습니다. 데이터 유형: 문자열 |
| 시작 | 필수 사용 가능한 예약 가능한 모듈을 검색하는 데 사용할 시작 시간입니다. 이 값은 매개변수에 end 지정된 값보다 커야 합니다. 데이터 유형: 문자열 형식: UTC 또는 현지 시간(yyyy-mm-dd hh:mm:ss) |
| time_slot | 가장 일치하는 예약 가능 항목을 찾으려는 시간대 기록의 Sys_id입니다. 시간 슬롯 [sn_wsd_rsv_time_slot] 테이블에 있습니다. 데이터 유형: 문자열 기본값: 없음 |
| 시간대 | 유럽/암스테르담 같은 기본 시간대 데이터 유형: 문자열 기본값: 없음 |
| 헤더 | 설명 |
|---|---|
| 없음 |
헤더
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.
| 헤더 | 설명 |
|---|---|
| 수용 | 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json |
| 헤더 | 설명 |
|---|---|
| 없음 |
상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.
| 상태 코드 | 설명 |
|---|---|
| 200 | 성공입니다. 요청이 성공적으로 처리되었습니다. |
| 401 | 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다. |
| 404 | 찾을 수 없습니다. 요청한 항목을 찾을 수 없습니다. |
| 500 | 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다. |
응답 본문 매개변수
| 이름 | 설명 |
|---|---|
| 결과 | 예약 가능한 최상의 일치에 대한 결과를 반환합니다. 데이터 유형: 객체 |
| result.floorsOfSelectedBuilding | 예약 가능한 층이 있는 층에 대한 상세 정보입니다. 데이터 유형: 객체 배열 |
| result.floorsOfSelectedBuilding.display_value | 예약 가능한 층이 있는 층의 번호(예: 12)를 표시합니다. 데이터 유형: 문자열 |
| result.floorsOfSelectedBuilding.external_id | 층의 외부 식별자입니다. 데이터 유형: 문자열 |
| result.floorsOfSelectedBuilding.name | 예약 가능한 항목이 있는 층의 이름입니다. 데이터 유형: 문자열 |
| result.floorsOfSelectedBuilding.sys_id | 층 [sn_wsd_core_floor] 테이블에 있는 관련 기록의 Sys_id입니다. 데이터 유형: 문자열 |
| result.has더 보기 | 반환 결과에 예약 가능한 항목이 더 있는지 여부를 나타내는 플래그입니다. 가능한 값:
데이터 유형: 부울 |
| result.nextItemIndex | 가져올 예약 가능한 다음 기록에 대한 인덱스입니다. 예약 가능한 기록을 페이지 매김할 때 이 값을 사용합니다. 데이터 유형: 숫자 |
| result.reservableContainers | selection_type 필드가 컨테이너로 설정된 예약 가능한 모듈에 대해서만 반환됩니다. 컨테이너는 책상 그룹과 같은 유사한 항목을 그룹화한 것입니다. 데이터 유형: 객체 배열 |
| result.reservableContainers.building | 예약 가능한 컨테이너와 연결된 건물에 대한 상세 정보입니다. 데이터 유형: 객체 |
| result.reservableContainers.building.display_value | 건물의 가치를 표시합니다. 데이터 유형: 문자열 |
| result.reservableContainers.building.name | 건물의 이름입니다. 데이터 유형: 문자열 |
| result.reservableContainers.building.sys_id | 관련된 건물 기록의 Sys_id입니다. 데이터 유형: 문자열 |
| result.reservableContainers.campus | 예약 가능한 항목이 위치한 캠퍼스에 대한 상세 정보입니다.
캠퍼스 [sn_wsd_core_campus] 테이블에 있습니다. 데이터 유형: 객체 |
| result.reservableContainers.campus.display_value | 예약 가능 항목이 있는 캠퍼스 번호(예: 이스트 베이)를 표시합니다. 데이터 유형: 문자열 |
| result.reservableContainers.campus.name | 캠퍼스의 이름입니다. 데이터 유형: 문자열 |
| result.reservableContainers.campus.sys_id | 연결된 기록의 Sys_id입니다. 캠퍼스 [sn_wsd_core_campus] 테이블에 있습니다. 데이터 유형: 문자열 |
| result.reservableContainers.capacity | 예약 가능한 항목의 최대 탑승자 수입니다. 데이터 유형: 숫자 |
| result.reservableContainers.display_value | 예약 가능한 컨테이너의 값을 표시합니다. 데이터 유형: 문자열 |
| result.reservableContainers.floor | 예약 가능한 컨테이너와 연결된 층의 상세 정보입니다. 데이터 유형: 객체 |
| result.reservableContainers.floor.display_value | 예약 가능한 층이 있는 층의 번호(예: 12)를 표시합니다. 데이터 유형: 문자열 |
| result.reservableContainers.floor.name | 예약 가능한 항목이 있는 층의 이름입니다. 데이터 유형: 문자열 |
| result.reservableContainers.floor.sys_id | 층 [sn_wsd_core_floor] 테이블에 있는 관련 기록의 Sys_id입니다. 데이터 유형: 문자열 |
| result.reservableContainers.image | 연결된 예약 가능한 항목의 레이아웃을 나타내는 이미지의 상세 정보입니다. 이미지 [db_image] 테이블에 있습니다. |
| result.reservableContainers.image.link | 이 예약 가능한 항목의 레이아웃을 나타내는 이미지로 연결되는 링크입니다. 이미지 [db_image] 테이블에 있습니다. 데이터 유형: 문자열 |
| result.reservableContainers.image.sys_id | 연결된 이미지 기록의 Sys_id입니다. 데이터 유형: 문자열 |
| result.reservableContainers.sys_id | 연결된 컨테이너 기록의 Sys_id입니다. 모든 컨테이너 유형에 대해 이 테이블이 있는 테이블을 구성할 수 있습니다. 기본적으로 이 테이블은 영역 [sn_wsd_core_area] 테이블에 있습니다. 데이터 유형: 문자열 |
| result.reservableUnits | 지정된 검색 기준과 일치하는 예약 가능한 단위에 대한 상세 정보입니다. 예약 가능한 단위는 책상이나 의자와 같이 예약할 수 있는 단일 항목입니다. 데이터 유형: 객체 |
| result.reservableUnits.area | 예약 가능한 모듈이 위치한 영역에 대한 상세 정보입니다. 영역 [sn_wsd_core_area] 테이블에 있습니다. 데이터 유형: 객체 |
| result.reservableUnits.area.display_value | 예약 가능한 모듈 영역의 값을 표시합니다. 데이터 유형: 문자열 |
| result.reservableUnits.area.sys_id | 예약 가능한 항목과 연결된 영역 기록의 Sys_id입니다. 데이터 유형: 문자열 |
| result.reservableUnits.availableTimes | 연결된 예약 가능한 날짜/시간의 목록입니다. 데이터 유형: 배열 |
| result.reservableUnits.building | 예약 가능한 건물에 대한 상세 정보입니다. 건물 [sn_wsd_core_building] 테이블에 있습니다. 데이터 유형: 객체 |
| result.reservableUnits.building.display_value | 건물의 가치를 표시합니다. 데이터 유형: 문자열 |
| result.reservableUnits.building.sys_id | 관련된 건물 기록의 Sys_id입니다. 데이터 유형: 문자열 |
| result.reservableUnits.campus | 예약 가능한 항목이 위치한 캠퍼스에 대한 상세 정보입니다.
캠퍼스 [sn_wsd_core_campus] 테이블에 있습니다. 데이터 유형: 객체 |
| result.reservableUnits.campus.display_value | 예약 가능 항목이 있는 캠퍼스 번호(예: 이스트 베이)를 표시합니다. 데이터 유형: 문자열 |
| result.reservableUnits.campus.sys_id | 연결된 기록의 Sys_id입니다. 캠퍼스 [sn_wsd_core_campus] 테이블에 있습니다. 데이터 유형: 문자열 |
| result.reservableUnits.capacity | 예약 가능한 항목의 최대 탑승자 수입니다. 데이터 유형: 숫자 |
| result.reservableUnits.defaultPrivacyValue | 예약 가능한 항목의 기본 개인정보 설정을 나타내는 플래그입니다. 이러한 개인 정보 설정에 대한 자세한 내용은 위치 개인 정보 설정 및 영향을 참조하세요. 가능한 값:
데이터 유형: 부울 |
| result.reservableUnits.description | 예약 가능 항목에 대한 간략한 설명입니다. 데이터 유형: 문자열 |
| result.reservableUnits.email | 예약 가능한 항목의 이메일 주소입니다. 데이터 유형: 문자열 |
| result.reservableUnits.external_id | CMS에 매핑된 공간을 동기화하는 데 사용되는 예약 가능한 외부 ID입니다. 이 값은 이 위치와 연결된 맵이 있는 경우에만 채워집니다. 데이터 유형: 문자열 |
| result.reservableUnits.floor | 예약 가능한 층이 있는 층에 대한 상세 정보입니다.
층 [sn_wsd_core_floor] 테이블에 있습니다. 데이터 유형: 객체 |
| result.reservableUnits.floor.display_value | 예약 가능한 층이 있는 층의 번호(예: 12)를 표시합니다. 데이터 유형: 문자열 |
| result.reservableUnits.floor.sys_id | 층 [sn_wsd_core_floor] 테이블에 있는 관련 기록의 Sys_id입니다. 데이터 유형: 문자열 |
| result.reservableUnits.image | 연결된 예약 가능한 항목의 레이아웃을 나타내는 이미지의 상세 정보입니다. 이미지 [db_image] 테이블에 있습니다. |
| result.reservableUnits.image.link | 이 예약 가능한 항목의 레이아웃을 나타내는 이미지로 연결되는 링크입니다. 이미지 [db_image] 테이블에 있습니다. 데이터 유형: 문자열 |
| result.reservableUnits.image.sys_id | 연결된 이미지 기록의 Sys_id입니다. 데이터 유형: 문자열 |
| result.reservableUnits.includedInResult | 현재 예약 가능한 항목이 반환 결과에 포함되는지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 부울 |
| result.reservableUnits.is_available | 예약 가능한 항목을 예약할 수 있는지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 부울 |
| result.reservableUnits.is_favorite | 예약 가능 항목에 연관된 사용자의 즐겨찾기 중 하나로 플래그가 지정되었는지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 부울 |
| result.reservableUnits.is_reservable | 이 예약 가능한 항목을 예약할 수 있는지 여부를 나타내는 플래그입니다. 주: include_unavailable_items 쿼리 매개 변수를 true로 설정하면 사용할 수 없는 위치도 반환됩니다. 이 경우 위치가 이미 예약된 경우 매개변수는 is_available false이지만 is_reservable true입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 부울 |
| result.reservableUnits.is_reserved | 예약 가능한 항목이 이미 예약되었는지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 부울 |
| result.reservableUnits.is_selected | 예약 가능한 항목이 이미 예약되었는지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 부울 |
| result.reservableUnits.location_type | 직장/책상, 카페, 체육관 등 예약 가능한 위치의 유형에 대한 상세 정보입니다. 직장 위치[sn_wsd_core_workplace_location] 테이블에 있습니다. |
| result.reservableUnits.location_type.display_value | 위치 유형의 표시 값입니다. 데이터 유형: 문자열 |
| result.reservableUnits.location_type.name | 지하실 또는 저장소와 같은 위치 유형의 이름입니다. 표시 값과 동일합니다. 데이터 유형: 문자열 |
| result.reservableUnits.location_type.sys_id | 공간 유형 [sn_wsd_core_space_type] 테이블에 있는 관련된 기록의 Sys_id입니다. 데이터 유형: 문자열 |
| result.reservableUnits.name | 예약 가능한 항목의 이름입니다. 데이터 유형: 문자열 |
| 결과.예약 가능한 단위.번호 | 예약 가능한 항목의 고유 식별자입니다. 이 값은 sys_id보다 사람이 더 쉽게 읽을 수 있습니다. 데이터 유형: 문자열 |
| 결과.예약 가능한 단위.순서 | 예약 가능한 항목의 순서 번호입니다. 데이터 유형: 숫자 |
| result.reservableUnits.require_approval | 예약 가능한 항목을 예약하는 데 승인이 필요한지 여부를 나타내는 플래그입니다. 가능한 값:
데이터 유형: 부울 |
| result.reservableUnits.requires_check_in | 예약 가능한 항목의 사용자 체크인이 필요한지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 부울 |
| result.reservableUnits.reservable_purposes | 연결된 예약 가능 항목을 예약하는 목적에 대한 상세 정보입니다. 데이터 유형: 객체 배열 |
| result.reservableUnits.reservable_purposes.이름 | 예약 가능한 항목의 이름입니다. 데이터 유형: 문자열 |
| result.reservableUnits.reservable_purposes.short_description | 예약 가능 항목에 대한 간략한 설명입니다. 데이터 유형: 문자열 |
| result.reservableUnits.reservable_purposes.sys_id | 예약 가능한 용도 기록의 Sys_id입니다. 예약 가능한 용도[sn_wsd_rsv_reservable_purpose] 테이블에 있습니다. 데이터 유형: 문자열 |
| result.reservableUnits.reservations | 예약 가능한 항목과 연결된 예약에 대한 상세 정보입니다. 쿼리 매개변수가 true이고 매개변수에 reservation_ids 예약 ID가 포함되어 있는 경우에만 include_reservations_within_days 채워집니다. 즉, 이 예약 가능한 항목에 대한 예약이 이미 있습니다. 데이터 유형: 객체 배열 |
| result.reservableUnits.reservations.configuration_item | 예약에 해당하는 구성 항목입니다. cmdb_ci 테이블에 있습니다. 데이터 유형: 문자열 |
| 결과.예약 가능한 유닛.예약.종료 | 예약 종료 날짜 및 시간입니다. 데이터 유형: 문자열 형식: UTC: yyyy-mm-ddThh:mm:ssZ(예: 2021-02-05T18:00:00Z) |
| result.reservableUnits.reservations.is_collided | 예약이 검색 시작 및 종료 시간과 충돌하는지 여부를 나타내는 플래그입니다. 연결된 예약 가능한 위치가 지정된 검색 시간 범위에 대해 이미 예약되었음을 나타냅니다. 가능한 값:
데이터 유형: 부울 |
| 결과.예약 가능한 단위.예약.위치 | 예약 위치에 대한 상세 정보입니다. 데이터 유형: 객체 |
| 결과.예약 가능한 단위.예약.위치.위치 | 연결된 위치 기록의 Sys_id입니다. 직장 위치[sn_wsd_core_workplace_location] 테이블에 있습니다. 데이터 유형: 문자열 |
| 결과.예약 가능한 단위.예약.위치.시간대 | 위치와 연결된 시간대에 대한 상세 정보입니다. 데이터 유형: 객체 |
| result.reservableUnits.reservations.location.timezone.displayValue | 이 위치가 속한 표준 시간대의 표시 값입니다. 데이터 유형: 문자열 |
| result.reservableUnits.reservations.location.timezone.value | 이 위치가 속한 표준 시간대의 내부 값입니다. 데이터 유형: 문자열 |
| 결과.예약 가능한 단위.예약.번호 | 예약 가능한 항목의 고유 식별자입니다. 이 값은 sys_id보다 사람이 더 쉽게 읽을 수 있습니다. 데이터 유형: 문자열 |
| result.reservableUnits.reservations.requested_for | 대신 예약을 요청한 사람에 대한 상세 정보입니다. 데이터 유형: 객체 |
| result.reservableUnits.reservations.requested_for.이름 | 예약이 요청된 사용자의 이름입니다. 데이터 유형: 문자열 |
| result.reservableUnits.reservations.requested_for.sys_id | 예약을 요청 중인 사용자의 Sys_id입니다. 사용자 [sys_user] 테이블에 있습니다. 데이터 유형: 문자열 |
| result.reservableUnits.reservations.reservation_purpose | 예약의 목적에 대한 상세 정보입니다. 데이터 유형: 객체 |
| result.reservableUnits.reservations.reservation_purpose.display_value | 회사 회의와 같은 예약 목적에 대한 값을 표시합니다. 데이터 유형: 문자열 |
| result.reservableUnits.reservations.reservation_purpose.값 | company_meeting과 같이 예약 목적에 대한 내부 값입니다. 데이터 유형: 문자열 |
| 결과.reservableUnits.reservations.start | 예약 시작 날짜 및 시간입니다. 데이터 유형: 문자열 형식: UTC - yyyy-mm-ddThh:mm:ssZ(예: 2021-02-05T18:00:00Z) |
| 결과.reservableUnits.reservations.state | 위치의 예약 상태에 대한 상세 정보입니다. 데이터 유형: 객체 |
| result.reservableUnits.reservations.state.display_value | 확인됨 등 예약의 현재 상태에 대한 값을 표시합니다. 데이터 유형: 문자열 |
| result.reservableUnits.reservations.state.value | 예약의 현재 상태에 대한 내부 값입니다(예: 2). 데이터 유형: 문자열 |
| 결과.예약 가능한 단위.예약.제목 | 예약의 주제입니다. 데이터 유형: 문자열 |
| result.reservableUnits.reservations.sys_id | 필수 예약 기록의 Sys_id입니다. 직장 예약[sn_wsd_rsv_reservation] 테이블에 있습니다. 데이터 유형: 문자열 |
| result.reservableUnits.reservable_quantity | 연결된 예약 가능한 시간을 동시에 예약할 수 있는 최대 횟수입니다. 이 값은 영역에 인접한 공간을 할당할 때 사용됩니다. 데이터 유형: 정수 |
| result.reservableUnits.showPrivacyOption | 직원이 연결된 예약 가능한 항목에 대한 개인정보 설정을 재정의할 수 있는지 여부를 나타내는 플래그입니다. 이러한 개인 정보 설정에 대한 자세한 내용은 위치 개인 정보 설정 및 영향을 참조하세요. 유효한 값은 다음과 같습니다.
데이터 유형: 부울 |
| result.reservableUnits.site | 예약 가능한 서버가 있는 현장에 대한 상세 정보입니다. 사이트 [sn_wsd_core_site] 테이블에 있습니다. |
| result.reservableUnits.site.display_value | 사이트의 표시 값입니다. 데이터 유형: 문자열 |
| result.reservableUnits.site.sys_id | 사이트 [sn_wsd_core_site] 테이블에 있는 연결된 사이트 기록의 Sys_id입니다. 데이터 유형: 문자열 |
| result.reservableUnits.standard_services | 플립 차트, 프로젝터 스크린, 화이트보드 및 마커와 같은 연관된 표준 서비스입니다. 데이터 유형: 객체 배열
|
| result.reservableUnits.standard_services.font_awesome_icon | 표준 서비스와 연결된 썸네일 아이콘의 이름입니다. 데이터 유형: 문자열 |
| result.reservableUnits.standard_services.name | 표준 서비스와 연결된 썸네일 아이콘의 이름입니다. 데이터 유형: 문자열 |
| result.reservableUnits.standard_services.short_description | 표준 서비스에 대한 간략한 설명입니다. 데이터 유형: 문자열 |
| result.reservableUnits.standard_services.sys_id | 표준 서비스 기록의 Sys_id입니다. 표준 서비스 [sn_wsd_rsv_standard_service] 테이블에 있습니다. 데이터 유형: 문자열 |
| result.reservableUnits.sys_id | 예약 가능한 기록의 Sys_id입니다. 직장 위치[sn_wsd_core_workplace_location] 테이블에 있습니다. 데이터 유형: 문자열 |
| result.reservableUnits.tableName | 예약 가능한 기록이 있는 테이블의 이름입니다. 데이터 유형: 문자열 |
| result.reservableUnits.title | 예약 가능한 항목의 제목입니다. 데이터 유형: 문자열 |
cURL 요청
다음 코드 예제에서는 이 끝점을 호출하는 방법을 보여 줍니다.
curl "https://instance.servicenow.com/api/sn_wsd_rsv/search/best_match?q=building%3D9e0364cedb3650106c731dcd1396192b&start=2023-01-04T07%3A00%3A00Z&time_slot=d5331cf2dbb5f01038e42b24ca961906&end=2023-01-04T17%3A00%3A00Z&best_match_count=1&reservable_module=2b636b7e1b4e60103523ff751a4bcbe2&timezone=Europe%2FAmsterdam" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
반환 결과:
{
"result": {
"hasMore": false,
"reservableUnits": [
{
"sys_id": "fe1f744edb7650106c731dcd139619ca",
"external_id": null,
"email": null,
"name": "Aspen",
"title": "Aspen",
"description": "A room with large windows, dark leather seats and a large wooden table.",
"image": {
"sys_id": "41c74902dbb650106c731dcd13961944",
"link": "41c74902dbb650106c731dcd13961944.iix"
},
"number": "ROOM0000903",
"site": {
"sys_id": "628eec06db7650106c731dcd139619dd",
"display_value": "North America"
},
"campus": {
"sys_id": "82b2a0cedb3650106c731dcd139619e9",
"display_value": "California Campus"
},
"building": {
"sys_id": "94e264cedb3650106c731dcd13961919",
"display_value": "CAL-B1"
},
"floor": {
"sys_id": "2f554296dbba10106c731dcd139619ed",
"display_value": "Floor 2"
},
"area": null,
"capacity": "16",
"reservable_quantity": null,
"location_type": {
"sys_id": "20713b83eb512010b89bfdfc9c522899",
"display_value": "Room",
"name": "Room"
},
"order": null,
"requires_check_in": null,
"is_reservable": "1",
"tableName": "sn_wsd_core_room",
"require_approval": false,
"standard_services": [
{
"sys_id": "abd0c18edb7650106c731dcd13961965",
"name": "Projector screen",
"short_description": "Connect laptop to screen (HDMI and DVI)",
"font_awesome_icon": "fa-caret-square-o-right"
}
],
"reservable_purposes": [
{
"sys_id": "18f4c3cd1ba4e01051848489cc4bcb82",
"name": "Board room",
"short_description": null
}
],
"is_available": true,
"reservations": [
{
"sys_id": "5fe65830874bc9106342b846dabb352b",
"number": "WRES0001001",
"location": {
"location": "fe1f744edb7650106c731dcd139619ca",
"timezone": {
"value": "US/Pacific",
"displayValue": "US/Pacific"
}
},
"configuration_item": null,
"start": "2022-04-23T08:30:00Z",
"end": "2022-04-23T09:30:00Z",
"subject": null,
"reservation_purpose": {
"value": "meeting",
"display_value": "Meeting"
},
"state": {
"value": "confirmed",
"display_value": "Confirmed"
},
"is_collided": false,
"requested_for": {
"sys_id": "2de07e1887cb89106342b846dabb35fe",
"name": "Workplace User"
}
},
{
"sys_id": "af075c30874bc9106342b846dabb3572",
"number": "WRES0001002",
"location": {
"location": "fe1f744edb7650106c731dcd139619ca",
"timezone": {
"value": "US/Pacific",
"displayValue": "US/Pacific"
}
},
"configuration_item": null,
"start": "2022-04-23T23:00:00Z",
"end": "2022-04-24T00:00:00Z",
"subject": null,
"reservation_purpose": {
"value": "meeting",
"display_value": "Meeting"
},
"state": {
"value": "confirmed",
"display_value": "Confirmed"
},
"is_collided": false,
"requested_for": {
"sys_id": "2de07e1887cb89106342b846dabb35fe",
"name": "Workplace User"
}
}
],
"availableTimes": [
[
"2022-04-23 07:00:00",
"2022-04-23 08:30:00"
],
[
"2022-04-23 09:30:00",
"2022-04-23 23:00:00"
],
[
"2022-04-24 00:00:00",
"2022-04-24 06:59:59"
]
],
"is_favorite": false
}
],
"reservableContainers": [],
"nextItemIndex": -1,
"floorsOfSelectedBuilding": [
{
"sys_id": "2f554296dbba10106c731dcd139619ed",
"display_value": "Floor 2",
"external_id": null,
"name": "Floor 2"
}
]
}
}{
"result": {
"hasMore": false,
"reservableUnits": [
{
"sys_id": "32f2a98adb7210106c731dcd13961972",
"external_id": null,
"wsd_email": null,
"name": "B1-03-04",
"title": "B1-03-04",
"description": "Desk reserved for the Team-C. After 10am, free to reserve for everyone.",
"image": {
"sys_id": "57b42dcadb7210106c731dcd13961945",
"link": "57b42dcadb7210106c731dcd13961945.iix"
},
"number": "SPCE0009018",
"site": {
"sys_id": "b17220cedb3650106c731dcd1396197a",
"display_value": "Western Europe"
},
"campus": {
"sys_id": "44d2e0cedb3650106c731dcd13961988",
"display_value": "Amsterdam Campus"
},
"building": {
"sys_id": "9e0364cedb3650106c731dcd1396192b",
"display_value": "AMS-B1"
},
"floor": {
"sys_id": "5373a8cedb3650106c731dcd1396198a",
"display_value": "Floor 3"
},
"area": {
"sys_id": "410ff04edb7650106c731dcd13961973",
"display_value": "Desks C1"
},
"capacity": "1",
"reservable_quantity": null,
"location_type": {
"sys_id": "5f017383eb512010b89bfdfc9c5228c8",
"display_value": "Workspace/Desk",
"name": "Workspace/Desk"
},
"order": null,
"requires_check_in": null,
"is_reservable": "1",
"tableName": "sn_wsd_core_space",
"require_approval": false,
"is_available": true,
"reservations": [],
"availableTimes": [
[
"2023-01-04 07:00:00",
"2023-01-04 17:00:00"
]
],
"showPrivacyOption": false,
"defaultPrivacyValue": false,
"container": {
"sys_id": "410ff04edb7650106c731dcd13961973",
"display_value": "Desks C1",
"floor": {
"sys_id": "5373a8cedb3650106c731dcd1396198a",
"display_value": "Floor 3",
"name": "Floor 3"
},
"building": {
"sys_id": "9e0364cedb3650106c731dcd1396192b",
"display_value": "AMS-B1",
"name": "AMS-B1"
},
"campus": {
"sys_id": "44d2e0cedb3650106c731dcd13961988",
"display_value": "Amsterdam Campus",
"name": "Amsterdam Campus"
},
"capacity": 6,
"image": {
"sys_id": "d52c27b21b8e60103523ff751a4bcb49",
"link": "d52c27b21b8e60103523ff751a4bcb49.iix"
}
},
"includedInResult": true,
"is_favorite": true
}
],
"reservableContainers": [
{
"sys_id": "410ff04edb7650106c731dcd13961973",
"display_value": "Desks C1",
"floor": {
"sys_id": "5373a8cedb3650106c731dcd1396198a",
"display_value": "Floor 3",
"name": "Floor 3"
},
"building": {
"sys_id": "9e0364cedb3650106c731dcd1396192b",
"display_value": "AMS-B1",
"name": "AMS-B1"
},
"campus": {
"sys_id": "44d2e0cedb3650106c731dcd13961988",
"display_value": "Amsterdam Campus",
"name": "Amsterdam Campus"
},
"capacity": 6,
"image": {
"sys_id": "d52c27b21b8e60103523ff751a4bcb49",
"link": "d52c27b21b8e60103523ff751a4bcb49.iix"
}
}
],
"nextItemIndex": -1,
"floorsOfSelectedBuilding": [
{
"sys_id": "5373a8cedb3650106c731dcd1396198a",
"display_value": "Floor 3",
"external_id": null,
"name": "Floor 3"
}
]
}
WSD 검색 - GET /api/sn_wsd_rsv/search/overlapping_reservation
전달된 매개변수를 기반으로 중복된 예약이 존재하는지 여부를 결정합니다.
URL 형식
버전이 지정된 URL: / api/sn_wsd_rsv/{api_version}/search/overlapping_reservation
기본 URL: / api/sn_wsd_rsv/search/overlapping_reservation
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| api_version | 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| 종료 | 필수 중복된 예약을 확인하는 데 사용할 종료 시간입니다. 데이터 유형: 문자열 형식: YYY-MM-DDTHH:MM:SSZ |
| recurring_pattern | 예약의 반복 패턴에 대한 상세 정보입니다. 데이터 유형: 객체 |
| recurring_pattern.기간 | 확인할 시간입니다. 데이터 유형: 숫자 단위: 초 |
| recurring_pattern.옵션 | 반복 예약과 연결된 옵션에 대한 상세 정보입니다. 데이터 유형: 객체 |
| recurring_pattern.options.count | 패턴이 반복되는 횟수입니다. 데이터 유형: 숫자 |
| recurring_pattern.options.daysOfWeek | 중복을 확인할 요일입니다. 유효한 값은 다음과 같습니다.
예를 들어 화요일, 목요일 및 금요일을 지정하려면 245(구분 기호 없음)를 전달합니다. 데이터 유형: 문자열 |
| recurring_pattern.옵션.every | 확인할 패턴 반복 간격입니다. 예를 들어, 이 값이 2이면 매개변수의 선택 repeats 에 따라 반복 패턴(예: 격일 또는 격주마다)을 확인합니다. 데이터 유형: 숫자 |
| recurring_pattern.options.repeats | 예약 중복 확인에 대한 반복 패턴입니다. 가능한 값: (대/소문자 구분)
데이터 유형: 문자열 |
| reservable_id | 중복된 예약을 확인하기 위한 예약 가능한 모듈의 Sys_id입니다. 예약 가능한 모듈 [sn_wsd_rsv_reservable_module] 테이블에 있습니다. 데이터 유형: 문자열 |
| reservation_id | 중복을 확인할 예약의 Sys_id입니다. 이 값은 다중/그룹 상위의 편집 흐름에 필요합니다. 직장 예약[sn_wsd_rsv_reservation] 테이블에 있습니다. 데이터 유형: 문자열 |
| shift_info_object | 중복을 확인할 교대조의 상세 정보입니다. 교대조 기반 예약에 대한 자세한 내용은 교대조 기반 예약 사용을 참조하세요. 데이터 유형: 객체 |
| shift_info_object.applyToShift | 예약 가능한 모듈에 대해 교대조 기반 예약을 사용할 수 있는지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 부울 |
| shift_info_object.시프트 | 예약과 연결할 교대조의 Sys_id입니다. 교대조 [sn_wsd_core_shift] 테이블에 있습니다. 이 매개 변수가 전달 end 되면 매개 변수가 필요하지 않습니다. 데이터 유형: 문자열 |
| shift_info_object.시간대 | 중복을 확인할 교대조의 시간대입니다. 데이터 유형: 문자열 |
| 시작 | 필수 중복된 예약을 확인하는 데 사용할 시작 시간입니다. 데이터 유형: 문자열 형식: YYY-MM-DDTHH:MM:SSZ |
| user_id | 필수 중복된 예약을 확인하는 사용자의 Sys_id입니다. 사용자 [sys_user] 테이블에 있습니다. 데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| 없음 |
헤더
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.
| 헤더 | 설명 |
|---|---|
| 수용 | 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json |
| 헤더 | 설명 |
|---|---|
| 없음 |
상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.
| 상태 코드 | 설명 |
|---|---|
| 200 | 성공입니다. 요청이 성공적으로 처리되었습니다. |
| 400 | 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다. |
| 401 | 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다. |
| 404 | 찾을 수 없습니다. 요청한 항목을 찾을 수 없습니다. |
| 500 | 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다. |
응답 본문 매개변수(JSON 또는 XML)
| 이름 | 설명 |
|---|---|
| 결과 | 중복 검사 결과에 대한 상세 정보입니다. 데이터 유형: 객체 |
| results.isOverlapped | 중복된 예약이 있는지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 부울 |
| results.reservableId | 그룹 예약의 경우 중복이 발생하는 예약 가능 항목의 sys_id입니다. 데이터 유형: 문자열 |
cURL 요청
다음 코드 예제에서는 특정 사용자 및 and end 매개 변수로 표시된 특정 기간에 대한 예약 중복을 start 확인하는 방법을 보여 줍니다.
curl "http://instance.servicenow.com/api/sn_wsd_rsv/search/overlapping_reservation?user_id=2e617fecc3d365101e38b23bb00131ec&end=2023-06-19T8:00:00Z&start=2023-06-19T07:00:00Z" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'
반환 결과:
{
"results": {
"isOverlapped": True,
"reservableId": ""
}
}
WSD 검색 - GET /api/sn_wsd_rsv/search/reservable
지정된 예약 가능한 모델 구성을 사용하여 사용 가능한 예약 가능한 항목을 검색합니다.
URL 형식
버전이 지정된 URL: / api/sn_wsd_rsv/{api_version}/search/reservable
기본 URL: / api/sn_wsd_rsv/search/reservable
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| api_version | 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| 종료 | 필수 사용 가능한 예약 가능한 모듈을 검색하는 데 사용할 종료 시간입니다. 이 값은 매개 변수에 지정된 start 값보다 이후여야 합니다. 데이터 유형: 문자열 형식: UTC 또는 현지 시간(yyyy-mm-dd hh:mm:ss) |
| exclude_reservables | 검색 결과에서 제외할 하나 이상의 예약 가능 sys_ids 목록입니다. 이러한 sys_ids이 있는 테이블은 예약 가능한 모듈 [sn_wsd_rsv_reservable_module] 테이블의 reservable_table 필드에 지정됩니다. 공간 [sn_wsd_core_space] 또는 방 [sn_wsd_core_room] 테이블일 수 있습니다. 데이터 유형: 문자열 또는 배열 |
| ignore_same_day_validation | 예약 검색이 시작 매개변수와 종료 매개변수 간의 날짜 확인 변경을 무시하는지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 부울 기본값: false |
| include_reservable_purposes | 반환 결과에서 각 예약 가능한 항목에 대한 직장 위치를 예약하는 목적을 반환할지 여부를 나타내는 플래그입니다. 이 정보는 예약 가능한 목적[sn_wsd_rsv_reservable_purpose] 테이블에 있습니다. 유효한 값은 다음과 같습니다.
데이터 유형: 부울 기본값: false |
| include_reservations_within_days | 하루 종일 예약 가능한 각 예약 가능한 항목에 대한 응답에서 사용 가능한 시간의 사용 가능한 슬롯을 모두 반환할지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 부울 기본값: false |
| include_standard_services | 응답에서 표준 서비스 정보를 반환할지 여부를 나타내는 플래그입니다. 표준 서비스는 화이트 보드, 추가 모니터 및 유사한 서비스와 같이 예약 가능한 직장 항목과 함께 사용할 수 있는 기본 조항을 설명합니다. 표준 서비스에 대한 자세한 내용은 표준 서비스를 참조하세요. 이 정보는 표준 서비스[sn_wsd_rsv_standard_service] 테이블에 있습니다. 유효한 값은 다음과 같습니다.
데이터 유형: 부울 기본값: false |
| near_by_location_id | 매개변수가 rsv_pathbrowse_near_a_person로 설정된 경우 필수입니다. 인코딩된 쿼리에 사용할 위치의 Sys_id입니다. 직장 위치[sn_wsd_core_workplace_location] 테이블에 있습니다. 데이터 유형: 문자열 |
| 인접 |
Space Management(sn_wsd_spc_mgmt_neighborhood) 플러그인이 활성화된 경우에만 사용할 수 있습니다. 인코딩된 쿼리에 사용할 인접 기록의 Sys_id입니다. 이웃 [sn_wsd_spcmgmt_neighborhood] 테이블에 있습니다. 인접 공간 예약에 대한 자세한 내용은 을 참조하십시오 Create neighborhood reservations. 데이터 유형: 문자열 |
| next_item_index | 검색할 다음 항목의 인덱스입니다. 반환 결과를 페이지 매김할 때 이 매개변수를 전달합니다. 데이터 유형: 숫자 기본값: 0 |
| page_size | 반환 결과에서 반환할 최대 기록 수입니다. 데이터 유형: 숫자 기본값: 6 |
| q | 필수 검색 반환 결과를 필터링하는 데 사용할 인코딩된 쿼리입니다. 이 쿼리 내에서 건물 sys_id 지정해야 하며 층, 면적, 용량, 표준 서비스 및 reservable_purposes과 같은 매개변수를 지정할 수 있습니다. 숫자인 용량을 제외하고 전달된 모든 매개변수는 sys_ids여야 합니다. 예: q=building=94e264cedb3650106c731dcd13961919^floorINfc7368cedb3650106c731dcd13961902^capacity>=1^standard_services=55c0818edb7650106c731dcd13961904 다음 테이블에서 이 정보를 찾을 수 있습니다.
데이터 유형: 문자열 |
| reservable_module | 필수 검색에 포함할 예약 가능한 모듈의 Sys_id입니다. 예약 가능한 모듈은 유사한 유형의 직장 항목을 그룹화합니다. 예약 가능한 모듈 [sn_wsd_rsv_reservable_module] 테이블에 있습니다. 데이터 유형: 문자열 |
| reservation_ids | 기존 예약 sys_ids의 쉼표로 구분된 목록입니다. 연결된 예약을 편집하려면 이 매개변수를 전달합니다. 직장 예약[sn_wsd_rsv_reservation] 테이블에 있습니다. 이러한 sys_ids에서 해당 예약 가능한 항목에 대해 차단된 시간은 사용 가능한 것으로 처리됩니다. 데이터 유형: 문자열 기본값: 없음 |
| rsv_path | 검색에 적용할 예약 경로입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 기본값: browse_all |
| schedule_view_obj | 반환할 일정 뷰에 대한 상세 정보입니다. 1일 이상 걸친 예약에 대해 24시간 가용성 데이터가 필요한 경우 이 개체를 전달합니다. 반환 결과에는 지정된 날짜의 사용 가능한 시간과 예약만 포함됩니다. 이 기능이 제대로 작동하려면 매개변수 ignore_same_day_validation 와 include_reservations_within_daystrue로 설정해야 합니다. 데이터 유형: 객체 |
| schedule_view_obj.일정_뷰_날짜 | 예약 가능 여부 반환을 시작할 날짜입니다. 이 날짜는 매개변수에 지정된 시간대에 schedule_view_obj.timezone 있어야 합니다. 데이터 유형: 문자열 형식: YYYY-MM-DD |
| schedule_view_obj.시간대 | 반환할 예약 가용성 데이터를 결정하는 데 사용할 건물 시간대입니다. 예: 미국/태평양. 데이터 유형: 문자열 |
| 시작 | 필수 사용 가능한 예약 가능한 모듈을 검색하는 데 사용할 시작 시간입니다. 이 값은 매개변수에 end 지정된 값보다 커야 합니다. 데이터 유형: 문자열 형식: UTC 또는 현지 시간(yyyy-mm-dd hh:mm:ss) |
| Shift | 예약과 연결할 교대조의 Sys_id입니다. 교대조 [sn_wsd_core_shift] 테이블에 있습니다. 이 매개 변수가 전달 end 되면 매개 변수가 필요하지 않습니다. 교대조 기반 예약에 대한 자세한 내용은 교대조 기반 예약 사용을 참조하세요. 데이터 유형: 문자열 |
| sort_by | 반환된 예약 가능 항목의 원하는 정렬 순서입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 기본값: a_z |
| 시간대 | 유럽/암스테르담 같은 기본 시간대 데이터 유형: 문자열 기본값: 없음 |
| 이름 | 설명 |
|---|---|
| 없음 |
헤더
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.
| 헤더 | 설명 |
|---|---|
| 수용 | 요청 본문의 데이터 형식입니다. 지원되는 유형: application/json, 또는, text/xmlapplication/xml . 기본값: application/json |
| 헤더 | 설명 |
|---|---|
| 없음 |
상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.
| 상태 코드 | 설명 |
|---|---|
| 200 | 성공입니다. 요청이 성공적으로 처리되었습니다. |
| 401 | 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다. |
| 404 | 찾을 수 없습니다. 요청한 항목을 찾을 수 없습니다. |
| 500 | 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다. |
응답 본문 매개변수
| 이름 | 설명 |
|---|---|
| 결과 | 지정된 검색에 대한 결과를 반환합니다. 데이터 유형: 객체 |
| 결과.필터 | 층, 표준 서비스, 예약 가능한 항목의 목적에 대한 상세 정보입니다. include_standard_services 또는 include_reservable_purposes 매개 변수가 false standard_services 로 설정되고 reservable_purposes 빈 배열인 경우. 데이터 유형: 객체 |
| 결과.필터.바닥 | 예약 가능한 층이 있는 층에 대한 상세 정보입니다.
층 [sn_wsd_core_floor] 테이블에 있습니다. 데이터 유형: 객체 |
| result.filter.floors.display_value | 예약 가능한 층이 있는 층의 번호(예: 12)를 표시합니다. 데이터 유형: 문자열 |
| result.filter.floors.sys_id | 층 [sn_wsd_core_floor] 테이블에 있는 관련 기록의 Sys_id입니다. 데이터 유형: 문자열 |
| result.filter.standard_services | 매개변수가 true로 설정된 경우에만 include_standard_services 채워집니다. 플립 차트, 프로젝터 스크린, 화이트보드 및 마커와 같은 연관된 표준 서비스입니다. 데이터 유형: 객체 배열
|
| result.filter.standard_services.font_awesome_icon | 표준 서비스와 연결된 썸네일 아이콘의 이름입니다. 데이터 유형: 문자열 |
| result.filter.standard_services.name | 표준 서비스의 이름입니다. 데이터 유형: 문자열 |
| result.filter.standard_services.short_description | 표준 서비스에 대한 간략한 설명입니다. 데이터 유형: 문자열 |
| result.filter.standard_services.sys_id | 표준 서비스 기록의 Sys_id입니다. 표준 서비스 [sn_wsd_rsv_standard_service] 테이블에 있습니다. 데이터 유형: 문자열 |
| result.filter.reservable_purposes | 연결된 예약 가능 항목을 예약하는 목적에 대한 상세 정보입니다. 데이터 유형: 객체 배열 |
| result.filter.reservable_purposes.name | 예약 가능한 항목의 이름입니다. 데이터 유형: 문자열 |
| result.filter.reservable_purposes.short_description | 예약 가능 항목에 대한 간략한 설명입니다. 데이터 유형: 문자열 |
| result.filter.reservable_purposes.sys_id | 예약 가능한 용도 기록의 Sys_id입니다. 예약 가능한 용도[sn_wsd_rsv_reservable_purpose] 테이블에 있습니다. 데이터 유형: 문자열 |
| result.has더 보기 | 반환 결과에 예약 가능한 항목이 더 있는지 여부를 나타내는 플래그입니다. 가능한 값:
데이터 유형: 부울 |
| 결과.nextFavIndex | 사용자가 예약할 수 있는 다음 즐겨찾기에 대한 인덱스입니다. 사용자의 즐겨찾기 예약 가능 항목을 통해 페이지 매김할 때 이 값을 사용합니다. 데이터 유형: 숫자 |
| result.nextItemIndex | 가져올 예약 가능한 다음 기록에 대한 인덱스입니다. 예약 가능한 기록을 페이지 매김할 때 이 값을 사용합니다. 데이터 유형: 숫자 |
| result.reservableContainers | selection_type 필드가 컨테이너로 설정된 예약 가능한 모듈에 대해서만 반환됩니다. 컨테이너는 책상 그룹과 같은 유사한 항목을 그룹화한 것입니다. 데이터 유형: 객체 배열 |
| result.reservableContainers.building | 예약 가능한 컨테이너와 연결된 건물에 대한 상세 정보입니다. 데이터 유형: 객체 |
| result.reservableContainers.building.display_value | 건물의 가치를 표시합니다. 데이터 유형: 문자열 |
| result.reservableContainers.building.name | 건물의 이름입니다. 데이터 유형: 문자열 |
| result.reservableContainers.building.sys_id | 관련된 건물 기록의 Sys_id입니다. 데이터 유형: 문자열 |
| result.reservableContainers.campus | 예약 가능한 항목이 위치한 캠퍼스에 대한 상세 정보입니다.
캠퍼스 [sn_wsd_core_campus] 테이블에 있습니다. 데이터 유형: 객체 |
| result.reservableContainers.campus.display_value | 예약 가능 항목이 있는 캠퍼스 번호(예: 이스트 베이)를 표시합니다. 데이터 유형: 문자열 |
| result.reservableContainers.campus.name | 캠퍼스의 이름입니다. 데이터 유형: 문자열 |
| result.reservableContainers.campus.sys_id | 연결된 기록의 Sys_id입니다. 캠퍼스 [sn_wsd_core_campus] 테이블에 있습니다. 데이터 유형: 문자열 |
| result.reservableContainers.capacity | 예약 가능한 항목의 최대 탑승자 수입니다. 데이터 유형: 숫자 |
| result.reservableContainers.display_value | 예약 가능한 컨테이너의 값을 표시합니다. 데이터 유형: 문자열 |
| result.reservableContainers.floor | 예약 가능한 컨테이너와 연결된 층의 상세 정보입니다. 데이터 유형: 객체 |
| result.reservableContainers.floor.display_value | 예약 가능한 층이 있는 층의 번호(예: 12)를 표시합니다. 데이터 유형: 문자열 |
| result.reservableContainers.floor.name | 예약 가능한 항목이 있는 층의 이름입니다. 데이터 유형: 문자열 |
| result.reservableContainers.floor.sys_id | 층 [sn_wsd_core_floor] 테이블에 있는 관련 기록의 Sys_id입니다. 데이터 유형: 문자열 |
| result.reservableContainers.image | 이 예약 가능한 항목의 레이아웃을 나타내는 이미지로 연결되는 링크입니다. 이미지 [db_image] 테이블에 있습니다. 데이터 유형: 문자열 |
| result.reservableContainers.image.link | 이 예약 가능한 항목의 레이아웃을 나타내는 이미지로 연결되는 링크입니다. 이미지 [db_image] 테이블에 있습니다. 데이터 유형: 문자열 |
| result.reservableContainers.image.sys_id | 연결된 이미지 기록의 Sys_id입니다. 데이터 유형: 문자열 |
| result.reservableContainers.sys_id | 연결된 컨테이너 기록의 Sys_id입니다. 모든 컨테이너 유형에 대해 이 테이블이 있는 테이블을 구성할 수 있습니다. 기본적으로 이 테이블은 영역 [sn_wsd_core_area] 테이블에 있습니다. 데이터 유형: 문자열 |
| result.reservableUnits | 지정된 검색 기준과 일치하는 예약 가능한 단위에 대한 상세 정보입니다. 예약 가능한 단위는 책상이나 의자와 같이 예약할 수 있는 단일 항목입니다. 데이터 유형: 객체 |
| result.reservableUnits.area | 예약 가능한 모듈이 위치한 영역에 대한 상세 정보입니다. 영역 [sn_wsd_core_area] 테이블에 있습니다. 데이터 유형: 객체 |
| result.reservableUnits.area.display_value | 예약 가능한 모듈 영역의 값을 표시합니다. 데이터 유형: 문자열 |
| result.reservableUnits.area.sys_id | 예약 가능한 항목과 연결된 영역 기록의 Sys_id입니다. 데이터 유형: 문자열 |
| result.reservableUnits.availableTimes | 연결된 예약 가능한 날짜/시간의 목록입니다. 데이터 유형: 배열 |
| result.reservableUnits.building | 예약 가능한 건물에 대한 상세 정보입니다. 건물 [sn_wsd_core_building] 테이블에 있습니다. 데이터 유형: 객체 |
| result.reservableUnits.building.display_value | 건물의 가치를 표시합니다. 데이터 유형: 문자열 |
| result.reservableUnits.building.sys_id | 관련된 건물 기록의 Sys_id입니다. 데이터 유형: 문자열 |
| result.reservableUnits.campus | 예약 가능한 항목이 위치한 캠퍼스에 대한 상세 정보입니다.
캠퍼스 [sn_wsd_core_campus] 테이블에 있습니다. 데이터 유형: 객체 |
| result.reservableUnits.campus.display_value | 예약 가능 항목이 있는 캠퍼스 번호(예: 이스트 베이)를 표시합니다. 데이터 유형: 문자열 |
| result.reservableUnits.campus.sys_id | 연결된 기록의 Sys_id입니다. 캠퍼스 [sn_wsd_core_campus] 테이블에 있습니다. 데이터 유형: 문자열 |
| result.reservableUnits.capacity | 예약 가능한 항목의 최대 탑승자 수입니다. 데이터 유형: 숫자 |
| result.reservableUnits.description | 예약 가능 항목에 대한 간략한 설명입니다. 데이터 유형: 문자열 |
| result.reservableUnits.email | 예약 가능한 항목의 이메일 주소입니다. 데이터 유형: 문자열 |
| result.reservableUnits.external_id | CMS에 매핑된 공간을 동기화하는 데 사용되는 예약 가능한 외부 ID입니다. 이 값은 이 위치와 연결된 맵이 있는 경우에만 채워집니다. 데이터 유형: 문자열 |
| result.reservableUnits.floor | 예약 가능한 층이 있는 층에 대한 상세 정보입니다.
층 [sn_wsd_core_floor] 테이블에 있습니다. 데이터 유형: 객체 |
| result.reservableUnits.floor.display_value | 예약 가능한 층이 있는 층의 번호(예: 12)를 표시합니다. 데이터 유형: 문자열 |
| result.reservableUnits.floor.sys_id | 층 [sn_wsd_core_floor] 테이블에 있는 관련 기록의 Sys_id입니다. 데이터 유형: 문자열 |
| result.reservableUnits.image | 연결된 예약 가능한 항목의 레이아웃을 나타내는 이미지의 상세 정보입니다. 이미지 [db_image] 테이블에 있습니다. |
| result.reservableUnits.image.link | 이 예약 가능한 항목의 레이아웃을 나타내는 이미지로 연결되는 링크입니다. 이미지 [db_image] 테이블에 있습니다. 데이터 유형: 문자열 |
| result.reservableUnits.image.sys_id | 연결된 이미지 기록의 Sys_id입니다. 데이터 유형: 문자열 |
| result.reservableUnits.includedInResult | 현재 예약 가능한 항목이 반환 결과에 포함되는지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 부울 |
| result.reservableUnits.is_available | 예약 가능한 항목을 예약할 수 있는지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 부울 |
| result.reservableUnits.is_favorite | 예약 가능 항목에 연관된 사용자의 즐겨찾기 중 하나로 플래그가 지정되었는지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 부울 |
| result.reservableUnits.is_reservable | 이 예약 가능한 항목을 예약할 수 있는지 여부를 나타내는 플래그입니다. 주: include_unavailable_items 쿼리 매개 변수를 true로 설정하면 사용할 수 없는 위치도 반환됩니다. 이 경우 위치가 이미 예약된 경우 매개변수는 is_available false이지만 is_reservable true입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 부울 |
| result.reservableUnits.is_reserved | 예약 가능한 항목이 이미 예약되었는지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 부울 |
| result.reservableUnits.is_selected | 예약 가능한 항목이 이미 예약되었는지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 부울 |
| result.reservableUnits.location_type | 직장/책상, 카페, 체육관 등 예약 가능한 위치의 유형에 대한 상세 정보입니다. 직장 위치[sn_wsd_core_workplace_location] 테이블에 있습니다. |
| result.reservableUnits.location_type.display_value | 위치 유형의 표시 값입니다. 데이터 유형: 문자열 |
| result.reservableUnits.location_type.name | 지하실 또는 저장소와 같은 위치 유형의 이름입니다. 표시 값과 동일합니다. 데이터 유형: 문자열 |
| result.reservableUnits.location_type.sys_id | 공간 유형 [sn_wsd_core_space_type] 테이블에 있는 관련된 기록의 Sys_id입니다. 데이터 유형: 문자열 |
| result.reservableUnits.name | 예약 가능한 항목의 이름입니다. 데이터 유형: 문자열 |
| 결과.예약 가능한 단위.번호 | 예약 가능한 항목의 고유 식별자입니다. 이 값은 sys_id보다 사람이 더 쉽게 읽을 수 있습니다. 데이터 유형: 문자열 |
| 결과.예약 가능한 단위.순서 | 예약 가능한 항목의 순서 번호입니다. 데이터 유형: 숫자 |
| result.reservableUnits.require_approval | 예약 가능한 항목을 예약하는 데 승인이 필요한지 여부를 나타내는 플래그입니다. 가능한 값:
데이터 유형: 부울 |
| result.reservableUnits.requires_check_in | 예약 가능한 항목의 사용자 체크인이 필요한지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 부울 |
| result.reservableUnits.reservable_purposes | 연결된 예약 가능 항목을 예약하는 목적에 대한 상세 정보입니다. 데이터 유형: 객체 배열 |
| result.reservableUnits.reservable_purposes.이름 | 예약 가능한 항목의 이름입니다. 데이터 유형: 문자열 |
| result.reservableUnits.reservable_purposes.short_description | 예약 가능 항목에 대한 간략한 설명입니다. 데이터 유형: 문자열 |
| result.reservableUnits.reservable_purposes.sys_id | 예약 가능한 용도 기록의 Sys_id입니다. 예약 가능한 용도[sn_wsd_rsv_reservable_purpose] 테이블에 있습니다. 데이터 유형: 문자열 |
| result.reservableUnits.reservations | 예약 가능한 항목과 연결된 예약에 대한 상세 정보입니다. 쿼리 매개변수가 true이고 매개변수에 reservation_ids 예약 ID가 포함되어 있는 경우에만 include_reservations_within_days 채워집니다. 즉, 이 예약 가능한 항목에 대한 예약이 이미 있습니다. 데이터 유형: 객체 배열 |
| result.reservableUnits.reservations.configuration_item | 예약에 해당하는 구성 항목입니다. cmdb_ci 테이블에 있습니다. 데이터 유형: 문자열 |
| 결과.예약 가능한 유닛.예약.종료 | 예약 종료 날짜 및 시간입니다. 데이터 유형: 문자열 형식: UTC: yyyy-mm-ddThh:mm:ssZ(예: 2021-02-05T18:00:00Z) |
| result.reservableUnits.reservations.is_collided | 예약이 검색 시작 및 종료 시간과 충돌하는지 여부를 나타내는 플래그입니다. 연결된 예약 가능한 위치가 지정된 검색 시간 범위에 대해 이미 예약되었음을 나타냅니다. 가능한 값:
데이터 유형: 부울 |
| 결과.예약 가능한 단위.예약.위치 | 예약 위치에 대한 상세 정보입니다. 데이터 유형: 객체 |
| 결과.예약 가능한 단위.예약.위치.위치 | 연결된 위치 기록의 Sys_id입니다. 직장 위치[sn_wsd_core_workplace_location] 테이블에 있습니다. 데이터 유형: 문자열 |
| 결과.예약 가능한 단위.예약.위치.시간대 | 위치와 연결된 시간대에 대한 상세 정보입니다. 데이터 유형: 객체 |
| result.reservableUnits.reservations.location.timezone.displayValue | 이 위치가 속한 표준 시간대의 표시 값입니다. 데이터 유형: 문자열 |
| result.reservableUnits.reservations.location.timezone.value | 이 위치가 속한 표준 시간대의 내부 값입니다. 데이터 유형: 문자열 |
| 결과.예약 가능한 단위.예약.번호 | 예약 가능한 항목의 고유 식별자입니다. 이 값은 sys_id보다 사람이 더 쉽게 읽을 수 있습니다. 데이터 유형: 문자열 |
| result.reservableUnits.reservations.requested_for | 대신 예약을 요청한 사람에 대한 상세 정보입니다. 데이터 유형: 객체 |
| result.reservableUnits.reservations.requested_for.이름 | 예약이 요청된 사용자의 이름입니다. 데이터 유형: 문자열 |
| result.reservableUnits.reservations.requested_for.sys_id | 예약을 요청 중인 사용자의 Sys_id입니다. 사용자 [sys_user] 테이블에 있습니다. 데이터 유형: 문자열 |
| result.reservableUnits.reservations.reservation_purpose | 예약의 목적에 대한 상세 정보입니다. 데이터 유형: 객체 |
| result.reservableUnits.reservations.reservation_purpose.display_value | 회사 회의와 같은 예약 목적에 대한 값을 표시합니다. 데이터 유형: 문자열 |
| result.reservableUnits.reservations.reservation_purpose.값 | company_meeting과 같이 예약 목적에 대한 내부 값입니다. 데이터 유형: 문자열 |
| 결과.reservableUnits.reservations.start | 예약 시작 날짜 및 시간입니다. 데이터 유형: 문자열 형식: UTC - yyyy-mm-ddThh:mm:ssZ(예: 2021-02-05T18:00:00Z) |
| 결과.reservableUnits.reservations.state | 위치의 예약 상태에 대한 상세 정보입니다. 데이터 유형: 객체 |
| result.reservableUnits.reservations.state.display_value | 확인됨 등 예약의 현재 상태에 대한 값을 표시합니다. 데이터 유형: 문자열 |
| result.reservableUnits.reservations.state.value | 예약의 현재 상태에 대한 내부 값입니다(예: 2). 데이터 유형: 문자열 |
| 결과.예약 가능한 단위.예약.제목 | 예약의 주제입니다. 데이터 유형: 문자열 |
| result.reservableUnits.reservations.sys_id | 필수 예약 기록의 Sys_id입니다. 직장 예약[sn_wsd_rsv_reservation] 테이블에 있습니다. 데이터 유형: 문자열 |
| result.reservableUnits.reservable_quantity | 연결된 예약 가능한 시간을 동시에 예약할 수 있는 최대 횟수입니다. 이 값은 영역에 인접한 공간을 할당할 때 사용됩니다. 데이터 유형: 정수 |
| result.reservableUnits.site | 예약 가능한 서버가 있는 현장에 대한 상세 정보입니다. 사이트 [sn_wsd_core_site] 테이블에 있습니다. |
| result.reservableUnits.site.display_value | 사이트의 표시 값입니다. 데이터 유형: 문자열 |
| result.reservableUnits.site.sys_id | 사이트 [sn_wsd_core_site] 테이블에 있는 연결된 사이트 기록의 Sys_id입니다. 데이터 유형: 문자열 |
| result.reservableUnits.standard_services | 플립 차트, 프로젝터 스크린, 화이트보드 및 마커와 같은 연관된 표준 서비스입니다. 데이터 유형: 객체 배열
|
| result.reservableUnits.standard_services.font_awesome_icon | 표준 서비스와 연결된 썸네일 아이콘의 이름입니다. 데이터 유형: 문자열 |
| result.reservableUnits.standard_services.name | 표준 서비스와 연결된 썸네일 아이콘의 이름입니다. 데이터 유형: 문자열 |
| result.reservableUnits.standard_services.short_description | 표준 서비스에 대한 간략한 설명입니다. 데이터 유형: 문자열 |
| result.reservableUnits.standard_services.sys_id | 표준 서비스 기록의 Sys_id입니다. 표준 서비스 [sn_wsd_rsv_standard_service] 테이블에 있습니다. 데이터 유형: 문자열 |
| result.reservableUnits.sys_id | 예약 가능한 기록의 Sys_id입니다. 직장 위치[sn_wsd_core_workplace_location] 테이블에 있습니다. 데이터 유형: 문자열 |
| result.reservableUnits.tableName | 예약 가능한 기록이 있는 테이블의 이름입니다. 데이터 유형: 문자열 |
| result.reservableUnits.title | 예약 가능한 항목의 제목입니다. 데이터 유형: 문자열 |
| result.totalProcessed | 처리된 총 기록 수입니다. 데이터 유형: 숫자 |
cURL 요청
이 예시에서는 이 엔드포인트를 사용하여 예약 가능한 항목을 검색하는 방법을 보여줍니다. 참고: 쉽게 읽을 수 있도록 쿼리 매개변수에 줄 바꿈이 추가되었습니다.
curl "https://instance.servicenow.com/api/sn_wsd_rsv/search/reservable?
reservable_module=d9864189c3653910977396cb05013100&
start=2023-10-12T10:30:00Z&
end=2023-10-13T11:30:00Z&
include_standard_services=true&
include_reservable_purposes=true&
include_reservations_within_days=true&
include_unavailable_items=true&
near_by_location_id=undefined&
timezone=Europe/Paris&
page_size=6&
sort_by=a_z&
view=schedule&
rsv_path=browse_all&
ignore_same_day_validation=true&
schedule_view_obj={"schedule_view_date":"2023-10-12","timezone":"Europe/Paris"}&
q=building=dea39b1977220110b3d7be377b5a9955\
--request GET \
--header "Accept:application/json"
--user "username":"password"
반환 결과:
{
"result": {
"hasMore": true,
"reservableUnits": [
{
"sys_id": "fe1f744edb7650106c731dcd139619ca",
"external_id": null,
"email": null,
"name": "Aspen",
"title": "Aspen",
"description": "A room with large windows, dark leather seats and a large wooden table.",
"image": {
"sys_id": "41c74902dbb650106c731dcd13961944",
"link": "41c74902dbb650106c731dcd13961944.iix"
},
"number": "ROOM0000903",
"site": {
"sys_id": "628eec06db7650106c731dcd139619dd",
"display_value": "North America"
},
"campus": {
"sys_id": "82b2a0cedb3650106c731dcd139619e9",
"display_value": "California Campus"
},
"building": {
"sys_id": "94e264cedb3650106c731dcd13961919",
"display_value": "CAL-B1"
},
"floor": {
"sys_id": "2f554296dbba10106c731dcd139619ed",
"display_value": "Floor 2"
},
"area": null,
"capacity": "16",
"reservable_quantity": null,
"location_type": {
"sys_id": "20713b83eb512010b89bfdfc9c522899",
"display_value": "Room",
"name": "Room"
},
"order": null,
"requires_check_in": null,
"is_reservable": "1",
"tableName": "sn_wsd_core_room",
"require_approval": false,
"standard_services": [
{
"sys_id": "9b01458edb7650106c731dcd13961945",
"name": "Flip chart",
"short_description": "Flip chart with paper sheets",
"font_awesome_icon": "fa-calendar-o"
}
],
"reservable_purposes": [
{
"sys_id": "18f4c3cd1ba4e01051848489cc4bcb82",
"name": "Board room",
"short_description": null
}
],
"is_available": true,
"reservations": [
{
"sys_id": "5fe65830874bc9106342b846dabb352b",
"number": "WRES0001001",
"location": {
"location": "fe1f744edb7650106c731dcd139619ca",
"timezone": {
"value": "US/Pacific",
"displayValue": "US/Pacific"
}
},
"configuration_item": null,
"start": "2022-04-23T08:30:00Z",
"end": "2022-04-23T09:30:00Z",
"subject": null,
"reservation_purpose": {
"value": "meeting",
"display_value": "Meeting"
},
"state": {
"value": "confirmed",
"display_value": "Confirmed"
},
"is_collided": false,
"requested_for": {
"sys_id": "2de07e1887cb89106342b846dabb35fe",
"name": "Workplace User"
}
}
],
"availableTimes": [
[
"2022-04-23 07:00:00",
"2022-04-23 08:30:00"
],
[
"2022-04-23 09:30:00",
"2022-04-23 23:00:00"
]
],
"is_reserved": true,
"is_selected": true,
"includedInResult": true,
"is_favorite": false
}
],
"reservableContainers": [],
"nextItemIndex": -1,
"filter": {
"floors": [],
"standard_services": [
{
"sys_id": "9b01458edb7650106c731dcd13961945",
"name": "Flip chart",
"short_description": "Flip chart with paper sheets",
"font_awesome_icon": "fa-calendar-o"
}
],
"reservable_purposes": [
{
"sys_id": "18f4c3cd1ba4e01051848489cc4bcb82",
"name": "Board room",
"short_description": null
}
]
},
"totalProcessed": 2,
"nextFavIndex": 0
}
}
WSD 검색 - GET /api/sn_wsd_rsv/search/shift/{building_id}/{module_id}
Shift [sn_wsd_core_shift] 테이블에서 사용 가능한 교대조를 검색하는 데 사용할 수 있는 인코딩된 쿼리를 반환합니다.
지정된 예약 가능한 모듈의 appy_to_shift 필드가 활성화된 경우에만 적용할 수 있습니다. 그렇지 않으면 반환된 인코딩된 쿼리 문자열이 비어 있습니다.
URL 형식
버전이 지정된 URL: /api/sn_wsd_rsv/{api_version}/search/shift/{ building_id}/{module_id}
기본 URL: /api/sn_wsd_rsv/search/shift/{ building_id}/{module_id}
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| api_version | 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열 |
| building_id | 검색 쿼리에 포함할 건물의 Sys_id입니다. 건물 [sn_wsd_core_building] 테이블에 있습니다. 데이터 유형: 문자열 |
| module_id | 검색 쿼리에 포함할 예약 가능한 모듈의 Sys_id입니다. 예약 가능한 모듈 [sn_wsd_core_reservable_module] 테이블에 있습니다. 예약 가능한 모듈은 의자 또는 책상과 같은 유사한 유형의 직장 항목을 그룹화합니다. 데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| 없음 |
| 이름 | 설명 |
|---|---|
| end_date | 인코딩된 쿼리에 포함할 교대조 종료 날짜와 시간입니다. 데이터 유형: 문자열 형식: yyyy-mm-dd hh:mm:ss |
| start_date | 인코딩된 쿼리에 포함할 교대조 시작 날짜와 시간입니다. 데이터 유형: 문자열 형식: yyyy-mm-dd hh:mm:ss |
헤더
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.
| 헤더 | 설명 |
|---|---|
| 수용 | 요청 본문의 데이터 형식입니다. 지원되는 유형: application/json, 또는, text/xmlapplication/xml . 기본값: application/json |
| 헤더 | 설명 |
|---|---|
| 없음 |
상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.
| 상태 코드 | 설명 |
|---|---|
| 200 | 성공입니다. 요청이 성공적으로 처리되었습니다. |
| 401 | 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다. |
| 404 | 찾을 수 없습니다. 요청한 항목을 찾을 수 없습니다. |
| 500 | 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다. |
응답 본문 매개변수
| 이름 | 설명 |
|---|---|
| 결과 | 지정된 사용 가능한 교대조를 확보하는 데 사용할 인코딩된 쿼리입니다. 데이터 유형: 객체 |
| 모듈하시프트 | 지정된 예약 가능한 모듈에서 교대조를 사용할 수 있는지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 부울 |
| 쿼리 | 지정된 예약 가능한 모듈에 대한 교대조 정보를 검색하는 데 사용할 인코딩된 쿼리입니다. 데이터 유형: 문자열 |
cURL 요청
다음 코드 예제에서는 이 끝점을 사용하여 Shift로 인코딩된 쿼리를 가져오는 방법을 보여 줍니다.
curl "https://instance.servicenow.com/api/sn_wsd_rsv/search/shift/94e264cedb3650106c731dcd13961919/fc71f64fdb42a01097acc900399619a8?start_date=2022-04-23 16:00:00&end_date=2022-04-28 16:00:00" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
반환 결과:
{
"result": {
"moduleHasShift" : true,
"query" : "active=true^state=2^building=94e264cedb3650106c731dcd13961919^building.is_reservable=true^building.active=true^floorISEMPTY^ORfloor.is_reservable=true^floorISEMPTY^ORfloor.active=true^start<=2022-04-26 16:00:00^ORstartISEMPTY^end>=2022-04-28 16:00:00^ORendISEMPTY^start<=2022-04-28 16:00:00^ORstartISEMPTY^end>=2022-04-28 16:00:00^ORendISEMPTY"
}
}
WSD 검색 - POST /api/sn_wsd_rsv/search/availability_score
지정된 시간 슬롯의 예약 가능한 항목에 대한 가용성 점수를 반환합니다.
URL 형식
버전이 지정된 URL: / api/sn_wsd_rsv/{api_version}/search/availability_score
기본 URL: / api/sn_wsd_rsv/search/availability_score
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| api_version | 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| 없음 |
| 이름 | 설명 |
|---|---|
| recurringPattern(반복되는 패턴) | 매개변수가 지정되지 않은 경우 startEndDateTimes 필요합니다. 지정된 반복 이벤트에 사용할 수 있는 예약 가능 항목을 검색하는 데 사용할 반복 패턴입니다. 데이터 유형: 객체 |
| recurringPattern.duration | 필수 예약 가능한 항목을 사용할 수 있어야 하는 기간입니다. 데이터 유형: 숫자 단위: 밀리초 |
| recurringPattern.label | 반복 패턴에 대한 설명입니다(예: 매일 5회 반복). 데이터 유형: 문자열 |
| recurringPattern.options | 검색할 반복 예약에 사용할 수 있는 옵션입니다. 데이터 유형: 객체 |
| recurringPattern.options.count | 전달되지 않은 경우 endDate 필수입니다. 둘 다 전달 count 되면 가 사용됩니다. 회의 패턴을 반복하는 횟수입니다. 데이터 유형: 숫자 |
| recurringPattern.options.daysOfWeek | 매개 변수가 매주로 설정된 경우 recurringPattern.repeats 필요합니다. 예약 가능한 항목이 필요한 요일입니다. 유효한 값은 다음과 같습니다.
예를 들어 화요일, 목요일 및 금요일을 지정하려면 245(구분 기호 없음)를 전달합니다. 주별이고 count 5이고 daysOfWeek 245인 경우 repeat 반환 결과에서 합계는 데이터 유형: 문자열 |
| recurringPattern.options.endDate | 전달되지 않은 경우 recurringPattern.options.count 필수입니다. 둘 다 전달 count 되면 가 사용됩니다. 회의가 반복되는 종료 날짜 및 시간입니다(예: "2022-07-08T14:00:00Z"). 데이터 유형: 문자열 형식: UTC yyyy-mm-dd hh:mm:ss |
| recurringPattern.options.every | 패턴 반복 간격입니다. 예를 들어, 이 값이 2이면 매개변수의 선택 repeats 에 따라 격일로 또는 격주로 패턴을 반복합니다. 데이터 유형: 숫자 |
| recurringPattern.repeats | 필수 예약 가능한 항목의 반복 패턴입니다. 유효한 값은 다음과 같습니다(대/소문자 구분):
데이터 유형: 문자열 |
| recurringPattern.startDate | 필수 반복 패턴의 시작 날짜 및 시간입니다(예: "2022-07-08T14:00:00Z"). 데이터 유형: 문자열 형식: UTC yyyy-mm-dd hh:mm:ss |
| reservableIds | 필수 가용성 점수에 포함할 예약 가능 항목의 sys_ids 목록입니다. 직장 위치[sn_wsd_core_workplace_location] 테이블에 있습니다. 데이터 유형: 배열 |
| 예약 가능한 유형 | 필수 가용성 점수에 포함할 예약 가능한 유형입니다. 검색을 구체화하는 데 사용됩니다. 유효한 값은 다음과 같습니다(대/소문자 구분):
데이터 유형: 문자열 |
| startEndDateTimes | 검색할 사용자의 시간대에 있는 시작 및 종료 날짜와 시간 목록입니다. 데이터 유형: 객체 배열
기본값: 매개변수를 지정해야 recurringPattern 합니다. |
| startEndDateTimes.end | 예약 가능한 항목의 종료 날짜와 시간입니다. 데이터 유형: 문자열 형식: yyyy-mm-dd hh:mm:ss |
| startEndDateTimes.start | 예약 가능한 항목의 시작 날짜 및 시간입니다. 데이터 유형: 문자열 형식: yyyy-mm-dd hh:mm:ss |
헤더
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.
| 헤더 | 설명 |
|---|---|
| 수용 | 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json |
| 컨텐츠-형식 | 요청 본문의 데이터 형식입니다. application/json만 지원합니다. |
| 헤더 | 설명 |
|---|---|
| 없음 |
상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.
| 상태 코드 | 설명 |
|---|---|
| 200 | 성공입니다. 요청이 성공적으로 처리되었습니다. |
| 401 | 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다. |
| 404 | 찾을 수 없습니다. 요청한 항목을 찾을 수 없습니다. |
| 500 | 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다. |
응답 본문 매개변수
| 이름 | 설명 |
|---|---|
| 결과 | 지정된 가용성 점수에 대한 결과를 반환합니다. 데이터 유형: 객체 |
| 결과.사용 가능 | 지정된 검색 기준을 충족하는 사용 가능한 예약 가능 수입니다. 데이터 유형: 숫자 |
| 결과.점수 | 가용성 점수입니다. 지정된 검색 기준을 충족하는 총 예약 가능 수를 초과하는 사용 가능한 예약 가능 수입니다. 예를 들어, available 가 2이고 total 4이면 값은 score 2/4입니다. 데이터 유형: 문자열 |
| 결과.합계 | 지정된 검색 기준을 충족하는 총 예약 가능 수입니다. 데이터 유형: 숫자 |
cURL 요청
다음 코드 예제에서는 이 끝점을 호출하는 방법을 보여 줍니다.
curl "https://instance.servicenow.com/api/sn_wsd_rsv/search/availability_score" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
\"reservableType\": \"location\",
\"reservableIds\": [
\"fe1f744edb7650106c731dcd139619ca\",
\"5eafb44edb7650106c731dcd13961943\"
],
\"recurringPattern\": {
\"duration\": 3600000,
\"repeats\": \"daily\",
\"options\": {
\"count\": 150,
\"daysOfWeek\": \"\",
\"every\": 1
},
\"label\": \"Repeats daily, 5 times\",
\"startDate\": \"2022-04-26T14:00:00Z\"
},
\"startEndDateTimes\": [
{
\"start\": \"2022-07-05 14:00:00\",
\"end\": \"2022-07-05 15:00:00\"
},
{
\"start\": \"2022-07-06 14:00:00\",
\"end\": \"2022-07-06 15:00:00\"
}
]
}" \
--user "username":"password"
반환 결과:
{
"result": {
"fe1f744edb7650106c731dcd139619ca": {
"available": 2,
"total": 2,
"score": "2/2"
},
"5eafb44edb7650106c731dcd13961943": {
"available": 2,
"total": 2,
"score": "2/2"
}
}