WSD 교대조 API

  • 릴리스 버전: Washingtondc
  • 업데이트 날짜 2024년 02월 01일
  • 읽기4분

    • (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 교대조 - GET /api/sn_wsd_rsv/wsd_shift/{shift_id}/timespan

    지정된 날짜/시간 및 교대조에 대한 교대조 시간 범위를 반환합니다.

    URL 형식

    버전이 지정된 URL: /api/sn_wsd_rsv/{api_version}/ wsd_shift/{shift_id}/timespan

    기본 URL: / api/sn_wsd_rsv/wsd_shift/{shift_id}/timespan

    지원되는 요청 매개변수

    표 1. 경로 매개변수
    이름 설명
    api_version 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다.

    데이터 유형: 문자열
    shift_id 시간 범위를 검색할 교대조의 Sys_id입니다. 교대조 [sn_wsd_core_shift] 테이블에 있습니다.

    교대조 기반 예약에 대한 자세한 내용은 교대조 기반 예약 사용을 참조하세요.

    데이터 유형: 문자열
    표 2. 쿼리 매개변수
    이름 설명
    attempt_earlier_start

    지정된 시작 값이 교대조의 시간 범위 내에 있는 경우 조기 시작 시간을 설정할지 여부를 나타내는 플래그입니다.

    유효한 값은 다음과 같습니다.
    • true: 지정된 교대조에 매개변수에 start 지정된 날짜/시간이 포함되어 있으면 지정된 시작 날짜/시간을 시간 범위의 시작으로 반환합니다.
    • false: 연결된 기록에 정의된 대로 교대조 시간 범위를 반환합니다.

    데이터 유형: 부울

    기본값: false
    시작 필수 복귀할 교대조 시간 범위가 시작되는 날짜 및 시간입니다.

    형식: UTC - yyyy-mm-ddThh:mm:ssZ(예: 2022-05-23T08:00:00Z)
    시간대 ECT 또는 PST와 같이 교대조 시간 범위를 한정할 때 사용하는 시간대입니다. 또한 이 시간대의 교대조 시간 범위를 반환합니다.

    형식: UTC

    데이터 유형: 문자열

    기본값: 사용자의 시간대
    표 3. 요청 본문 매개변수
    이름 설명
    없음

    헤더

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

    표 4. 요청 헤더
    헤더 설명
    수용 요청 본문의 데이터 형식입니다. 지원되는 유형: application/json, 또는, text/xmlapplication/xml .

    기본값: application/json
    표 5. 응답 헤더
    헤더 설명
    없음

    상태 코드

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

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

    응답 본문 매개변수

    이름 설명
    결과 검색 기준과 일치하는 교대조 시간 범위에 대한 상세 정보입니다.

    데이터 유형: 객체

    "result":{
  "end": "String",
  "start": "String"
}
    결과.종료 지정된 시간대의 교대조 시간 범위의 종료 날짜 및 시간입니다.

    형식: UTC: yyyy-mm-ddThh:mm:ssZ(예: 2022-05-23T08:00:00Z)

    데이터 유형: 문자열
    결과.시작 지정된 시간대의 교대조 시간 범위의 시작 날짜 및 시간입니다.

    형식: UTC: yyyy-mm-ddThh:mm:ssZ(예: 2022-05-23T08:00:00Z)

    데이터 유형: 문자열

    cURL 요청

    다음 코드 예제에서는 교대조의 시간 범위를 검색하는 방법을 보여 줍니다.

    curl "https://instance.servicenow.com/api/sn_wsd_rsv/wsd_shift/e5d23acfdb42a01097acc9003996193a/timespan?attempt_earlier_start=true&start=2022-05-23T08:00:00Z&timezone=ECT" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

    반환 결과:

    {
  "result": {
    "start": "2022-05-23T08:00:00Z",
    "end": "2022-05-23T15:00:00Z"
  }
}